-
Notifications
You must be signed in to change notification settings - Fork 38
docs: add docs folder #148
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
docs: add docs folder #148
Conversation
|
@patrickelectric Ready for review. After merging, docs will be published at https://docs.bluerobotics.com/ping-python |
|
Hi @dgarcia360, it would be nice to have the CI running without deployment to validate PR and avoid break of the build system. |
|
@patrickelectric Moving to "Draft" while I add a workflow that runs on every PR to ensure the build doesn’t break.
That’s the autodoc2 extension’s default behavior, but I’ll check if we can override it. |
|
Marking as ready for review just to debug the GitHub Actions error, do not merge yet |
c57e9f1 to
8e07392
Compare
fix: pingmessage.py warning chore: optimization chore: fix action rm: directory flag
6e64912 to
ad28c5b
Compare
|
Reviewing the code block lines separated issue and docstrings not rendering |
|
@patrickelectric Added the PR verification workflow and investigated autodoc2 styling. Functions were rendering one per line because they were not displaying the function descriptions underneath: This happened because the Python generator expected comments in the Google style docstring format, bu, but they were written using Doxygen syntax instead. Google Style docstring:
Doxygen:
To resolve this, we switched the generator from autodoc to breathe + exhale, which supports Doxygen. Now, descriptions are rendering correctly: |





Deletes Doxygen docs and adds Sphinx & the BlueRobotics theme to this project:
For more information, see Python docs generation.
How to test
docsfolder:cd docs.make preview.