docs: Move to Sphinx based generation #393
Merged
Conversation
This file contains 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
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #393 +/- ##
=======================================
Coverage 97.40% 97.40%
=======================================
Files 31 31
Lines 2581 2581
=======================================
Hits 2514 2514
Misses 67 67 ☔ View full report in Codecov by Sentry. |
stotko
force-pushed
the
sphinx_docs
branch
3 times, most recently
from
364c791
to
1ddb120
Compare
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.
While Doxygen Awesome provides not only provides a modern style to doxygen based documentation, it also comes with several modern stylistic elements such as dark mode, interactive tabs, copy buttons in code snippets, etc. However, the underlying doxygen based framework is still quite limited towards customization on the documentation level in comparison to frameworks like Sphinx and mkdocs.
Port the pure doxygen pipeline to a Sphinx based generation approach to enable a more fine-grained control over the style and structure. This marks the first steps towards a general modernization of the documentation, so the current state may be less polish than the previous pure doxygen docs in some regards.