Table of Contents Support

[nzjrs]

Hi,

With a large project, I have a catch-all everything API page, generated via

.. doxygenindex::
   :project: onboard

It would be great if there was an option which generated the correct table of contents for the resulting docs, as the page is very large and hard to navigate.

[michaeljones]

Hey,

Sorry for the slow reply. That's a good idea. I guess my gut reaction is that making some kind of nested list structure with appropriate links to the various class/functions wouldn't be too hard, but I've currently no experience with making that a first class table of contents. ie. something that get picked up in the side bar or by parent toctrees.

I can try to look into it and hopefully will, but I'll be honest I'm just at the start of a project at work right now and I'm keen to put some extra hours into that, so I might be running low on time for breathe :/

Do you have a pressing need for this? Or do you simply feel it would be useful?

Cheers,
Michael

[nzjrs]

Do you have a pressing need for this? Or do you simply feel it would be useful?

No pressing need at the moment, I just feel it would be useful.

Feel free to concentrate on work ;-)

Thanks

John

Cheers,
Michael

Reply to this email directly or view it on GitHub:
#38 (comment)

[michaeljones]

Cheers mate, that isn't me attempting to dismiss the idea, just trying to gain some perspective on when I can try to fit it in. I'll try to take a look at some point over the next week but it might be longer before we get anything working.

Of course, you're welcome to have a go at it if you're interested.

Thanks,
Michael

[ahundt]

I second this request, it would be extremely useful to me.

Thanks,
Andrew

[kitizz]

+1 this would be great! I'm particularly interested in having the member names in the floating Sidebar as you suggested.

I started navigating the source to see if I had any hope of implementing it. Daunting!
I might try to chip away at it over the next few weeks.

[vermeeren]

Probably either breathe-apidoc or https://github.com/svenevs/exhale do what is desired. If not, #321 will surely be the answer. Closing for now, comment if you disagree.

[Hirrolot]

So briefly, how can I generate a TOC for each header file?

[vermeeren]

@Hirrolot See the comment above yours, #38 (comment).