breathe icon indicating copy to clipboard operation
breathe copied to clipboard

Wrong formatting of markdown headers

Open rw1nkler opened this issue 4 years ago • 3 comments

The markdown headers from a Doxygen documentation are converted into italic. Probably they should have more distinctive formatting

Doxygen output: dox

Sphinx output: sphinx

Raw HTML:

<em>II. Lists </em>

Example

Source code: https://github.com/rw1nkler/breathe-tests

How to reproduce:

git clone https://github.com/rw1nkler/breathe-tests
cd breathe-tests/docs/
pip3 install -r requirements.txt
make html
make firefox/sphinx

rw1nkler avatar Jul 09 '20 17:07 rw1nkler

Which version of Breathe and Sphinx do you use? When I try your project in the newest versions I only get "This is a detailed description.". From a brief scan it looks like Breathe doesn't support the sectioning XML that gets generated (sect1, sect2, etc.). See e.g., https://github.com/michaeljones/breathe/blob/master/breathe/renderer/sphinxrenderer.py#L1148.

jakobandersen avatar Jul 10 '20 07:07 jakobandersen

Here is the list of used packages:

alabaster (0.7.12)
Babel (2.8.0)
breathe (4.19.2)
certifi (2020.6.20)
chardet (3.0.4)
docutils (0.16)
idna (2.10)
imagesize (1.2.0)
Jinja2 (2.11.2)
MarkupSafe (1.1.1)
packaging (20.4)
pip (9.0.1)
pkg-resources (0.0.0)
Pygments (2.6.1)
pyparsing (2.4.7)
pytz (2020.1)
requests (2.24.0)
setuptools (39.0.1)
six (1.15.0)
snowballstemmer (2.0.0)
Sphinx (3.1.2)
sphinx-rtd-theme (0.5.0)
sphinxcontrib-applehelp (1.0.2)
sphinxcontrib-devhelp (1.0.2)
sphinxcontrib-htmlhelp (1.0.3)
sphinxcontrib-jsmath (1.0.1)
sphinxcontrib-qthelp (1.0.3)
sphinxcontrib-serializinghtml (1.1.4)
urllib3 (1.25.9)

Doxygen version is 1.8.13

rw1nkler avatar Jul 10 '20 09:07 rw1nkler

Which version of Breathe and Sphinx do you use? When I try your project in the newest versions, I only get "This is a detailed description.". From a brief scan it looks like Breathe doesn't support the sectioning XML that gets generated (sect1, sect2, etc.). See, e.g., https://github.com/michaeljones/breathe/blob/master/breathe/renderer/sphinxrenderer.py#L1148.

It seems that this piece of code is not related to the problem. I set the breakpoint there, and the method was not invoked.


I figured out that this is an unsupported feature: https://github.com/michaeljones/breathe/blob/master/breathe/renderer/sphinxrenderer.py#L1083 How complicated would It be to provide that support?

rw1nkler avatar Jul 16 '20 13:07 rw1nkler