Publish API documentation to GitHub Pages via Sphinx - #52
Merged
Conversation
Adds Sphinx (autodoc + autosummary + napoleon) under docs/, generating javadoc-style API reference pages from the code's docstrings. A new docs.yml workflow builds the site and deploys it to GitHub Pages on every push to main, so it always reflects the latest merged code.
SonarCloud flagged the workflow-level contents:read grant as broader than needed. Only the build job checks out the repo, so scope the permission there instead of applying it to every job.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
SonarCloud flagged that omitting --only-binary :all: lets poetry build from source distributions, which executes that package's build/setup scripts. Set POETRY_INSTALLER_ONLY_BINARY=:all: on the install steps in docs.yml and test.yml so only prebuilt wheels are installed. Verified all current dependencies (sphinx, furo, pytest, pytest-cov, flake8, setuptools, and their transitive deps) publish wheels for py3.12 linux.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR provides:
docs/, generating javadoc-style API reference pages directly from the code's docstrings — no manual per-module doc files to maintain.github/workflows/docs.yml: builds the docs and deploys them to GitHub Pages on every push tomainsphinx/furoas a new Poetrydocsdependency group (kept separate from runtime deps), regeneratepoetry.lockpyproject.toml'sDocumentationURL and the README to point at the real docs site