mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2025-12-31 20:36:24 +00:00
sphinx-autobuild for live docs updates (#129)
* `sphinx-autobuild` for live docs updates. * Use Python 3.9 and `sphinx-autobuild` `2024.2.4`
This commit is contained in:
@ -99,7 +99,7 @@ jobs:
|
||||
docs:
|
||||
<<: *docs
|
||||
docker:
|
||||
- image: cimg/python:3.8
|
||||
- image: cimg/python:3.9
|
||||
environment:
|
||||
TOXENV: docs
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ version: 2
|
||||
build:
|
||||
os: ubuntu-22.04
|
||||
tools:
|
||||
python: "3.8"
|
||||
python: "3.9"
|
||||
|
||||
sphinx:
|
||||
configuration: docs/conf.py
|
||||
|
||||
4
Makefile
4
Makefile
@ -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
|
||||
|
||||
Reference in New Issue
Block a user