[doc] Parse module description as rst. #3008
Draft
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
Enable to build rich doc.
|
Can we have a problem with the doxygen doc of modules due to special characters or other strange formatting ? |
|
Doxygen formatted descriptions still builds in sphinx, but are not very nice-looking in the sphinx doc. I haven't tried to build doxygen doc. |
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.
The
descriptionnode of modules xml files are parsed as reStructuredText (sphinx syntax), allowing to build a rich and beautiful doc right from this file!All sphinx features should works: code blocks, images, hyperlinks, ...