Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bagatur/update py api ref #1251

Merged
merged 13 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ build:
- . .venv/bin/activate
- uv pip install -r python/docs/requirements.txt
- . .venv/bin/activate && cd python/docs && make clobber generate-api-rst html && cd ../..
- cp python/docs/_build/html/reference.html python/docs/_build/html/index.html
- cp -r python/docs/_build/html $READTHEDOCS_OUTPUT
# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
10 changes: 10 additions & 0 deletions python/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,13 @@ build:

publish:
poetry publish --dry-run

api_docs_build:
poetry run python docs/create_api_rst.py
cd docs && poetry run make html
poetry run python docs/scripts/custom_formatter.py docs/_build/html/
cp docs/_build/html/{reference,index}.html
open docs/_build/html/index.html

api_docs_clean:
git clean -fd ./docs/
15 changes: 10 additions & 5 deletions python/docs/_static/wordmark-api-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading