-
Notifications
You must be signed in to change notification settings - Fork 15
Generate Sphinx Documentation and document how to build it. #170
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Generate Sphinx Documentation and document how to build it. #170
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #170 +/- ##
======================================
Coverage 83.3% 83.3%
======================================
Files 23 23
Lines 3347 3347
======================================
Hits 2790 2790
Misses 557 557
|
Pull Request Test Coverage Report for Build 17274001479Details
💛 - Coveralls |
b867404
to
b2d41c9
Compare
8143779
to
999d1aa
Compare
999d1aa
to
7df3ffa
Compare
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
Signed-off-by: Bernhard Kaindl <[email protected]>
7df3ffa
to
2eae0b7
Compare
There was a problem hiding this comment.
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 adds comprehensive Sphinx documentation generation to the python-libs project, enabling automatic API documentation and documentation hosting on platforms like ReadTheDocs. The documentation uses Google-style docstrings and includes both project documentation and auto-generated module references.
- Configures Sphinx with autodoc, MyST parser, and Furo theme for modern documentation
- Updates existing docstrings to use consistent backtick formatting instead of single quotes
- Creates individual RST files for each XCP module with auto-documentation directives
Reviewed Changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
docs/source/conf.py | Main Sphinx configuration with autodoc and MyST parser setup |
docs/source/index.rst | Documentation homepage with project structure and module listing |
docs/source/*.rst | Individual module documentation files for auto-generated API docs |
docs/requirements.txt | Sphinx dependencies including furo theme and myst_parser |
docs/Makefile | Standard Sphinx makefile for building documentation |
.readthedocs.yml | ReadTheDocs configuration for automated documentation hosting |
xcp/cpiofile.py | Updated docstrings to use backticks instead of single quotes |
xcp/accessor.py | Improved docstring formatting with proper code block syntax |
README.md | Fixed markdown syntax and code block language tags |
DOCUMENTING.md | New documentation guide explaining Google-style docstrings and Sphinx usage |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Generate Sphinx Documentation and document how to build it.
The docs/static can be opened directly in a web browser, any static site and also readthedocs.io (config included).
Sample Preview URLs:
For further spelling fixes, please review #171 (for
CONTRIBUTING.md
), and the other non-draft PRs.Merging the cleanup PRs is a precondition for making spelling fixes (those would cause conflicts otherwise).