[DEV] Regen function doc strings on make docs (#977)
* [DEV] Regen docs with `make docs` * default 0
This commit is contained in:
parent
aa637d12dc
commit
caad4598fc
2 changed files with 3 additions and 1 deletions
1
Makefile
1
Makefile
|
|
@ -40,6 +40,7 @@ executable: clean
|
|||
pyinstaller ytdl-sub.spec
|
||||
mv dist/ytdl-sub dist/ytdl-sub${EXEC_SUFFIX}
|
||||
docs:
|
||||
REGENERATE_DOCS=1 pytest tests/unit/docgen/test_docgen.py
|
||||
sphinx-build -M html docs/source/ docs/build/
|
||||
clean:
|
||||
rm -rf \
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
import os
|
||||
from abc import abstractmethod
|
||||
from pathlib import Path
|
||||
|
||||
REGENERATE_DOCS: bool = False
|
||||
REGENERATE_DOCS: bool = bool(os.environ.get("REGENERATE_DOCS", 0))
|
||||
|
||||
|
||||
class DocGen:
|
||||
|
|
|
|||
Loading…
Reference in a new issue