Fix docs#455
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s documentation/README to improve published docs output (and enable publishing again), including restructuring content across the README and Sphinx pages and refreshing the CLI docs rendering.
Changes:
- Reworked
README.rstformatting (logo, updated intro, trimmed sections, updated links). - Added an “About” docs page sourced from the README intro plus additional content, and updated the docs index/toctree structure.
- Updated Sphinx HTML theme options and switched the CLI docs page to render directly from the Click entrypoint.
Reviewed changes
Copilot reviewed 6 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
README.rst |
Adds logo/header formatting and updates/condenses the README content and links. |
docs/source/misc/about.rst |
New “About” page that includes the README intro and restores detailed background sections. |
docs/source/index.rst |
Updates the docs navigation and changes what portion of the README is included on the landing page. |
docs/source/conf.py |
Adjusts theme options/title and sets a logo for HTML output. |
docs/source/cli.rst |
Renders CLI docs directly via sphinx-click from the Click main entrypoint. |
docs/source/_cli/compass.rst |
Removes the old CLI page stub (superseded by docs/source/cli.rst). |
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.
Fix README and touch up docs. Should be able to publish again