Docs: minor fixup - inserting API details #29
Merged
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.
Fix this:

Into this:

Note: if in the end the
Doxygen
+breathe
setup does not bring up much added value,in regards to the concerns expressed in #25 (comment),
feel free to get rid of it.
Maybe we can give it a few weeks / months to evaluate the benefit.
AMHA the Markdown-based Sphinx documentation is the most valuable part of the generated documentation.