Conversation
Sets up docs/source with autosummary-driven API reference (auto-generated from docstrings, no manual updates needed as modules are added), a placeholder user-guide section for future explanatory pages, and automatic version display via installed package metadata (setuptools_scm). Adds a docs GitHub Actions workflow that builds on push/PR to main and dev and deploys to GitHub Pages on merges to main. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0126spNDGtqDKMoYtuPT7JfW
Git doesn't track empty directories, so the _static dir referenced by html_theme_options never made it into the PR branch, and sphinx-build -W failed CI with "html_static_path entry '_static' does not exist". Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0126spNDGtqDKMoYtuPT7JfW
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0126spNDGtqDKMoYtuPT7JfW
docs: add Sphinx documentation with RTD theme and GitHub Pages deploy
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.
No description provided.