breathe

breathe copied to clipboard

Is the breathe_show_include setting meant only for struct/class?

2

I'm in the process to transition our documentation of a large C project from `doxygen` to `sphinx` using the `breathe` bridge and have stumpled across some problems. In particular, I...

RaumZeit

Memory Consumption of doxyindex & doxygenclass

44

I am trying to set up automated build of our docs on rtd, which is limited to 1 GB mem usage (and 15min build time). The sphinx step ``` reading...

ax3l

LaTeX in \f$ swallows \n newlines

2

CC @drmoose transferring https://github.com/svenevs/exhale/issues/173 to breathe which is the part of the stack responsible for rendering the doxygen xml output into html. I took a quick look at the renderer...

svenevs

breathe doesn't pass `c:function` properly with a C array syntax in parameter declaration

1

This was discovered in #816 when resolving all warning produced by `sphinx-build`. So, the test project (see link below) is taken from the original breathe docs, namely _examples/specific/array.h_. The C...

2bndy5

Versions: ``` Sphinx - 4.5.0 breathe - 4.34.0 exhale - 0.3.4 doxygen - 1.9.1 ``` Relevent input files: `ManagedString.h` --> https://github.com/lancaster-university/codal-core/blob/master/inc/types/ManagedString.h On line 2192 of `spinxrenderer.py` ( https://github.com/michaeljones/breathe/blob/master/breathe/renderer/sphinxrenderer.py#L2192 ) the...

JohnVidler

[WIP] Move union directive to be class-like

1

The union directive is currently classified as an "item", similar to typedefs, enums, and enumerators. However, formally it is a class type (https://en.cppreference.com/w/cpp/language/type), and in terms of documentation I think...

jakobandersen

4.30.0: sphinx 4.x warnings

8

First of all looks like setuptoolssphinx integration is not done. Below patch fixes that: ```patch --- a/setup.cfg~ 2021-05-06 20:43:49.000000000 +0100 +++ b/setup.cfg 2021-08-16 14:35:35.505071997 +0100 @@ -7,3 +7,6 @@ [bdist_wheel]...

kloczek

Fortran support

10

Currently, breathe will pass Fortran classes (derived types), namespaces (modules), procedures, ... as C++ code and sphinx will complain about the invalid syntax. Integrating Fortran code documentation in sphinx would...

awvwgk

Directive for Doxygen examples (xml compounds with kind="example")

1

I would like to be able to include single examples annotated with \example in the doxygen comment in the documentation. When using the `doxygenindex` directive, example sections are generated for...

chbauman

doxygenclass needs more options

1

I'd really prefer not to show the "Subclassed by" list, but I didn't see an option to remove it. Looks like `derivedcompoundref` already exists for this in the [doxygenfile sections](https://breathe.readthedocs.io/en/latest/file.html#file-example),...

AlCash07