Skip to content

Update docs and enable rtd#9

Merged
Weinsen merged 1 commit into
v0.0.7-rcfrom
chore/docs/update
May 16, 2026
Merged

Update docs and enable rtd#9
Weinsen merged 1 commit into
v0.0.7-rcfrom
chore/docs/update

Conversation

@Weinsen

@Weinsen Weinsen commented May 15, 2026

Copy link
Copy Markdown
Owner

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

  • Move project metadata and dependency declarations into pyproject.toml and remove the legacy setup.py and requirements.txt flow.
  • Add shared shell helpers plus dedicated lint and test entry points that resolve the repo Python environment and base ref consistently.
  • Expand CI to cover Python 3.13, release-candidate branches, editable installs, and draft pull request handling.
  • Reorganize the Sphinx docs for Read the Docs, fix the config path, rename the contributing page to match linked paths, and add a v0.0.7-rc changelog entry.
  • Add a pull request template and update the documented docs validation command.

Type of Change

  • Build/Infrastructure
  • Documentation

Validation

  • python -m sphinx docs html
  • python -m build

Notes for Reviewers

  • The direct Sphinx build now succeeds after the docs-path fixes.
  • The docs build still emits one warning from sphinx_autodoc_typehints when resolving a prompt_toolkit forward reference: NotImplementedOrNone.
  • Package and docs version strings remain at 0.0.7 to match the existing v*-rc branch convention.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.toml docs extras and project URLs to support RTD + Sphinx extensions/theme.
  • Reorganized Sphinx docs from docs/source/... into a RTD-friendly docs/ layout with a new docs/conf.py, new pages, and an updated docs/Makefile.
  • Refreshed README.rst assets/links (badge, example GIF path, contributing link) and expanded .gitignore build 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 thread docs/conf.py Outdated
Comment on lines +36 to +37
# Explicit master doc (Sphinx 4+ defaults to 'index' but be explicit).
master_doc = "index"
@Weinsen
Weinsen force-pushed the chore/docs/update branch from 3944fc0 to a775de2 Compare May 15, 2026 23:43
@Weinsen
Weinsen merged commit 80345d4 into v0.0.7-rc May 16, 2026
4 checks passed
@Weinsen
Weinsen deleted the chore/docs/update branch May 17, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants