Skip to content

Commit

Permalink
sphinx-autobuild for live docs updates (ethereum#129)
Browse files Browse the repository at this point in the history
* `sphinx-autobuild` for live docs updates.

* Use Python 3.9 and `sphinx-autobuild` `2024.2.4`
  • Loading branch information
reedsa committed Apr 15, 2024
1 parent d950ee7 commit 74f0a2f
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ jobs:
docs:
<<: *docs
docker:
- image: cimg/python:3.8
- image: cimg/python:3.9
environment:
TOXENV: docs

Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.8"
python: "3.9"

sphinx:
configuration: docs/conf.py
Expand Down
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
],
"docs": [
"sphinx>=6.0.0",
"sphinx-autobuild>=2024.2.4",
"sphinx_rtd_theme>=1.0.0",
"towncrier>=21,<22",
],
Expand Down

0 comments on commit 74f0a2f

Please sign in to comment.