Skip to content

Commit

Permalink
build(docs): add sphinx-apidoc to readthedocs configuration
Browse files Browse the repository at this point in the history
- Add pre_build step to generate API documentation
- Update .readthedocs.yaml to include sphinx-apidoc command
  • Loading branch information
tanbro committed Jan 21, 2025
1 parent 3a8171b commit e9a197a
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

build:
os: ubuntu-22.04
tools:
python: "3"

python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

build:
os: ubuntu-22.04
tools:
python: "3"
jobs:
pre_build:
- sphinx-apidoc -o docs/apidocs -f -e -H APIs src

python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .

0 comments on commit e9a197a

Please sign in to comment.