Skip to content

Commit

Permalink
Fix read the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eduardoklosowski committed Oct 24, 2024
1 parent 08d72c3 commit 4f3b0e3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,18 @@ build:
- curl -sSL https://install.python-poetry.org | python3 - --version 1.8.4
- $HOME/.local/bin/poetry config virtualenvs.create false
pre_install:
- $HOME/.local/bin/poetry export --only=docs -o requirements.txt
- $HOME/.local/bin/poetry export --only=main,type,docs -o requirements.txt
commands:
- sphinx-apidoc --remove-old -f -o docs/source/src src
- sphinx-build -T -b html -d _build/doctrees docs/source $READTHEDOCS_OUTPUT/html

python:
install:
- requirements: requirements.txt
- method: pip
path: .
extra_requirements:
- pytest

sphinx:
configuration: docs/source/conf.py
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ test-coverage-report: .coverage
.PHONY: docs docs-serve

docs $(DOCS_DIR)/build:
poetry run sphinx-apidoc --remove-old -f -o $(DOCS_SRC_DIR)/source/src $(SRC_DIR)
poetry run sphinx-apidoc --remove-old -f -o $(DOCS_SRC_DIR)/src $(SRC_DIR)
(cd $(DOCS_DIR) && poetry run make html)

docs-serve: $(DOCS_DIR)/build
Expand Down

0 comments on commit 4f3b0e3

Please sign in to comment.