Improve documentation and integrate Sphinx with GitHub Pages #39
Conversation
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
Replace arXiv links and BibTex entries with IEEE versions for referenced papers to ensure proper attribution.
- Update function and class docstrings in several modules. - Add missing module-level docstrings. This change ensures the project is correctly rendered in documentation pages built with Sphinx, and improves the overall documentation presentation.
- Standardize letter casing for "nonlinear" terminology. - Fix minor punctuation and formatting inconsistencies. - Improve structure of the "Controller Creation" section in "Code Structure".
Add a step to the "build" job in `release.yml` to convert source file links in `README.md` from relative paths to absolute GitHub URLs. This ensures the links point to their corresponding files on GitHub when rendered on PyPI.
|
All checks have passed. The Sphinx integration with GitHub Pages looks good. Merging now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR improves the project's documentation by integrating Sphinx and automating its deployment to GitHub Pages via a new
docs.ymlworkflow.Additionally, it updates the
release.ymlworkflow to convert source file links inREADME.mdfiles from relative paths to absolute GitHub URLs. This ensures the links point to their corresponding files on GitHub when rendered on PyPI.Key changes:
docs/directory.README.mdto improve its readability and structure.release.ymlto convert source file links inREADME.mdfrom relative paths to absolute GitHub URLs.docs.ymlworkflow for building and deploying docs to GitHub Pages.