Repository navigation
docs: changelog and other project docs - #67
Merged
Merged
Conversation
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Documentation build overview
|
There was a problem hiding this comment.
Pull request overview
Updates project documentation and metadata so users can find the changelog and related resources more easily, and so the Read the Docs site is linked consistently across the project.
Changes:
- Add a Sphinx changelog page that includes
CHANGELOG.md, and link it from the docs index. - Refresh project URL metadata in
pyproject.toml(changelog, release notes, docs, funding, etc.). - Update the README’s Read the Docs link to the canonical docs root.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updates the Read the Docs reference link to the canonical RTD root URL. |
| pyproject.toml | Expands and refreshes [project.urls] entries (docs, changelog, releases, funding, etc.). |
| docs/index.rst | Adds changelog to the Sphinx toctree so it appears in the docs navigation. |
| docs/changelog.rst | Introduces a Sphinx page that includes CHANGELOG.md via MyST parsing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.