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

Customize the order of sections #520

Open
tomghuang opened this issue May 5, 2020 · 1 comment
Open

Customize the order of sections #520

tomghuang opened this issue May 5, 2020 · 1 comment
Labels
enhancement Improvements, additions (also cosmetics)

Comments

@tomghuang
Copy link

When I use breath with Sphinx, Read the Doc Theme, and Doxygen, I can successfully insert a function API description in my Sphinx-based documentation. However, the sections are in the following order:

  • Return
  • See
  • Note
  • Warning
  • Parameters

However, I want to organize the sections in the order similar to MSDN documents:

  • Parameters
  • Return
  • Note
  • Warning
  • See

I tried to find a way to customize the section order, but couldn't find anything. May I know how specify the order of the sections? Thanks.

@vermeeren
Copy link
Collaborator

Support for section selecting and section order was recently added for doxygenfile and autodoxygenfile directives in #501 and #509. Documentation for that can be found at https://github.com/michaeljones/breathe/blob/master/documentation/source/file.rst, the RTD docs are currently not up-to-date due to #475.

Something else that may be of use, from https://github.com/michaeljones/breathe/blob/master/documentation/source/directives.rst#config-values, is breathe_order_parameters_first. Full support for section ordering for non-*file directives is not implemented I believe, you could submit a patch for this feature to get it into Breathe.

@vermeeren vermeeren added the enhancement Improvements, additions (also cosmetics) label Sep 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements, additions (also cosmetics)
Projects
None yet
Development

No branches or pull requests

2 participants