docs: move API references to new page#238
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the Sphinx documentation navigation by introducing an API Reference landing page and updating the index to link to it, while also adjusting the titles of the individual API reference pages.
Changes:
- Added a new
api_reference/API-Reference.rstlanding page that links to the existing API reference pages. - Updated
index.rstto point to the new landing page instead of listingeop/time/utilitiesdirectly. - Tweaked the top-level headings in
eop,time, andutilitiesAPI reference docs to use inline-literal formatting.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/source/index.rst | Updates the sidebar/toctree entry to route API docs through a new landing page. |
| doc/source/api_reference/API-Reference.rst | Adds an API Reference landing page that aggregates API subpages. |
| doc/source/api_reference/eop.rst | Updates the page title formatting for the eop API docs. |
| doc/source/api_reference/time.rst | Updates the page title formatting for the time API docs. |
| doc/source/api_reference/utilities.rst | Updates the page title formatting for the utilities API docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| :maxdepth: 1 | ||
| :hidden: | ||
| :caption: API Reference | ||
| :caption: User Guide |
Comment on lines
+8
to
+10
| ./eop.rst | ||
| ./time.rst | ||
| ./utilities.rst |
chore: update `pixi.lock` docs: convert installation and getting started pages to `myst-nb`
Contributor
|
Contributor
|
Contributor
|
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.