Fix empty documentation pages (API reference, license, basic example)#90
Merged
Conversation
The docs site deployed at the v0.12.1 release had three blank pages. Root causes and fixes: - API Reference: the nanobind .pyi stub (previously in install/stubs/, removed during cleanup) was gone, so sphinx-autoapi had no source to document for the compiled module. Regenerate it as src/touchpy/__init__.pyi and add src/touchpy/py.typed so it ships in the wheel for IDE type hints. - sphinx-autoapi 3.5 is incompatible with astroid 4 (calls AstroidBuilder() without the now-required manager arg); pin astroid<4 in docs/requirements.txt. - Set autoapi_file_patterns to read the .pyi over the re-exporting __init__.py. - License: fix include path from the removed install/LICENSE.md to ../../LICENSE.md. - Basic Example: replace the placeholder with a literalinclude of examples/01_load_comp_basic.py. Docs-only change; no package version bump. Redeploy via the Documentation workflow (workflow_dispatch).
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
1 participant
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.
The docs site deployed at the v0.12.1 release had three blank pages. Root causes and fixes:
Docs-only change; no package version bump. Redeploy via the Documentation workflow (workflow_dispatch).