Update docs and enable rtd#9
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR aligns the branch with the v0.0.7-rc release line by restructuring the Sphinx documentation for Read the Docs, updating packaging metadata in pyproject.toml, and refreshing top-level project documentation links/assets to match the new docs layout.
Changes:
- Updated
pyproject.tomldocs extras and project URLs to support RTD + Sphinx extensions/theme. - Reorganized Sphinx docs from
docs/source/...into a RTD-friendlydocs/layout with a newdocs/conf.py, new pages, and an updateddocs/Makefile. - Refreshed
README.rstassets/links (badge, example GIF path, contributing link) and expanded.gitignorebuild artifact ignores.
Reviewed changes
Copilot reviewed 13 out of 19 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.rst | Adds CI badge, fixes wording, updates docs image path, updates contributing link, adds license blurb. |
| pyproject.toml | Updates docs dependencies and adds additional project URL metadata (issues/docs). |
| docs/source/pages/documentation.rst | Removes old Sphinx doc page under deprecated docs/source layout. |
| docs/source/index.rst | Removes old Sphinx root index under deprecated docs/source layout. |
| docs/source/conf.py | Removes old Sphinx config under deprecated docs/source layout. |
| docs/pages/intro/known_issues.rst | Adds a new “Known Issues” page under the new docs layout. |
| docs/pages/intro/index.rst | Adds an intro section index/toctree for the new docs layout. |
| docs/pages/intro/getting_started.rst | Adds “Getting started” guide and first example app for the new docs layout. |
| docs/pages/howto/crafting.rst | Adds a how-to page for crafting commands in the new docs layout. |
| docs/pages/documentation.rst | Reintroduces API documentation page targeting updated module names. |
| docs/pages/contributing.rst | Adds local linting instructions and fixes a formatting artifact. |
| docs/pages/changelog.rst | Adjusts underline formatting in changelog sections. |
| docs/Makefile | Replaces the default Sphinx makefile with explicit apidoc and html targets for the new layout. |
| docs/make.bat | Removes Windows Sphinx build helper script. |
| docs/index.rst | Adds new docs root index/toctree for the new docs layout. |
| docs/images/example.gif | Adds the example GIF asset at the new path referenced by README/docs. |
| docs/conf.py | Adds new Sphinx configuration for RTD (theme, extensions, autosummary, typehints). |
| .readthedocs.yaml | Adds RTD build configuration pointing at docs/conf.py and installs .[docs]. |
| .gitignore | Updates ignored build outputs and virtual environment directory. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+36
to
+37
| # Explicit master doc (Sphinx 4+ defaults to 'index' but be explicit). | ||
| master_doc = "index" |
Weinsen
force-pushed
the
chore/docs/update
branch
from
May 15, 2026 23:43
3944fc0 to
a775de2
Compare
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
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.
Summary
Align the current branch with the v0.0.7-rc release line by finishing the packaging and tooling cleanup, repairing the docs publication path, and adding release notes for the RC changes.
What Changed
Type of Change
Validation
python -m sphinx docs htmlpython -m buildNotes for Reviewers