varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2025-12-31 20:36:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

sphinx-autobuild for live docs updates (#129)

Browse Source 
* `sphinx-autobuild` for live docs updates.

* Use Python 3.9 and `sphinx-autobuild` `2024.2.4`
This commit is contained in:
Stuart Reed
2024-04-15 11:23:46 -06:00
committed by GitHub
parent d950ee7376
commit 74f0a2fac9
4 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@ -8,6 +8,7 @@ help:
@echo "lint - fix linting issues with pre-commit"
@echo "test - run tests quickly with the default Python"
@echo "docs - generate docs and open in browser (linux-docs for version on linux)"
@echo "autobuild-docs - live update docs when changes are saved"
@echo "notes - consume towncrier newsfragments/ and update release notes in docs/"
@echo "release - package and upload a release (does not run notes target)"
@echo "dist - package"
@ -33,6 +34,9 @@ lint:
test:
pytest tests
autobuild-docs:
sphinx-autobuild --open-browser docs docs/_build/html
build-docs:
sphinx-apidoc -o docs/ . setup.py "*conftest*"
$(MAKE) -C docs clean