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

TOC not generated when using a particular Markdown header style #6791

Closed
mrsmond opened this issue Jan 21, 2019 · 5 comments
Closed

TOC not generated when using a particular Markdown header style #6791

mrsmond opened this issue Jan 21, 2019 · 5 comments
Labels

Comments

@mrsmond
Copy link

mrsmond commented Jan 21, 2019

Mainly as a note to others as this is not critical and has a work-around.

Doxygen v1.8.15

Table of contents (TOC) is not generated when using the === or --- style of headers in Markdown. It does generate correctly when using the # style of headers.

Example files attached. header_style_2.md (# style) works fine, however header_style_1.md:

Title {#mainpage}
===

[TOC]

One
===

Two
===

Three
===

Issues these warnings:

header_style_1.md:6: warning: multiple use of section label 'autotoc_md0' while adding section, (first occurrence: header_style_1.md, line 1)
header_style_1.md:9: warning: multiple use of section label 'autotoc_md1' while adding section, (first occurrence: header_style_1.md, line 1)
header_style_1.md:12: warning: multiple use of section label 'autotoc_md2' while adding section, (first occurrence: header_style_1.md, line 1)

As you can see from the Doxyfile, I have TOC_INCLUDE_HEADINGS > 0 as per #6513, which is related, but not the same problem. The extra header 1 section is needed due to bug #5892.

toc_test.tar.gz

@mrsmond
Copy link
Author

mrsmond commented Jan 21, 2019

Interestingly, the source for the markdown documentation page has a [TOC] at the start, but there is no TOC in the HTML output.

@albert-github
Copy link
Collaborator

albert-github commented Jan 21, 2019

The problem regarding the 'multiple use of section label' this was indeed the case in v1.8.15 but has been solved in the master version by the pull request #6780 based on issue #6779 and I see the TOC in both versions of the file in the master version of doxygen,.

The problem with [TOC] in the documentation has to be investigated a bit further.

albert-github added a commit to albert-github/doxygen that referenced this issue Jan 21, 2019
… header style

The default for the `TOC_INCLUDE_HEADERINGS` was set to 0, for compatibility this should be 5.
(Problem was observed in the doxygen documentation, chapter markdown, where the TOC was missing; alternatively in the Doxyfile the `TOC_INCLUDE_HEADERINGS` could be set to `5`,. The solution chosen is more consistent with the old situation).
@albert-github
Copy link
Collaborator

I've just pushed a proposed patch, pull request #6792, regarding the [TOC]

albert-github added a commit to albert-github/doxygen that referenced this issue Jan 21, 2019
doxygen added a commit that referenced this issue Jan 22, 2019
issue #6791 TOC not generated when using a particular Markdown headerstyle
@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Jan 22, 2019
@albert-github
Copy link
Collaborator

Code has been integrated in master on github.

@doxygen
Copy link
Owner

doxygen commented Aug 8, 2019

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.8.16.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Aug 8, 2019
@doxygen doxygen closed this as completed Aug 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants