danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[DEV] Regen function doc strings on make docs (#977)

Browse source 
* [DEV] Regen docs with `make docs`

* default 0
This commit is contained in:
Jesse Bannon 2024-04-27 14:06:16 -07:00 committed by GitHub
parent aa637d12dc
commit caad4598fc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Makefile
View file

@ -40,6 +40,7 @@ executable: clean
pyinstaller ytdl-sub.spec pyinstaller ytdl-sub.spec
mv dist/ytdl-sub dist/ytdl-sub${EXEC_SUFFIX} mv dist/ytdl-sub dist/ytdl-sub${EXEC_SUFFIX}
docs: docs:
REGENERATE_DOCS=1 pytest tests/unit/docgen/test_docgen.py
sphinx-build -M html docs/source/ docs/build/ sphinx-build -M html docs/source/ docs/build/
clean: clean:
rm -rf \ rm -rf \

3
tools/docgen/docgen.py
View file

@ -1,7 +1,8 @@
import os
from abc import abstractmethod from abc import abstractmethod
from pathlib import Path from pathlib import Path
REGENERATE_DOCS: bool = False REGENERATE_DOCS: bool = bool(os.environ.get("REGENERATE_DOCS", 0))
class DocGen: class DocGen: