Use native docutils for field lists, notes, and warnings #670
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.
For parameter lists, template parameter lists, return, throw, pre, and post, use the native field lists in docutils and make sure to collect them into a single field list per declaration to enable the Sphinx post transform that groups fields and makes cross-references (
DocFieldTransformer
).For warnings and notes, also use the native nodes as if the directives
warning
andnote
were used.Fixes #599.
Example
index.rst
:test.hpp
:Current Breathe rendering:
Similar raw manually written Sphinx, and rendering with this PR: