Skip to content
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

doc: use sphinx + breathe + doxygen to generate the documentation #238

Merged
merged 19 commits into from
Nov 22, 2023

Conversation

aabadie
Copy link
Contributor

@aabadie aabadie commented Nov 21, 2023

This is a follow-up of #237 which uses Sphinx with the breather extension to generate the documentation. The sphinx doc uses the pydata-sphinx-theme because it is nice.
There's a lot of room for improvements but the result is already much better than with Doxygen alone.

In terms of CI, the make doc command is configured to build doxygen first and then run sphinx-build in "warning as error" and "nitpicks" mode.

@aabadie aabadie added the documentation Improvements or additions to documentation label Nov 21, 2023
@aabadie aabadie merged commit e3632d1 into DotBots:main Nov 22, 2023
19 checks passed
@aabadie aabadie deleted the sphinx branch November 22, 2023 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant