svenevs / exhale

Automatic C++ library api documentation generation: breathe doxygen in and exhale it out.
BSD 3-Clause "New" or "Revised" License
218 stars 51 forks source link

Module Index Error 404 page #182

Open mwestphal opened 1 year ago

mwestphal commented 1 year ago

I'm using exhale to deploy a doxygen documentation here. https://f3d.app/doc/libf3d/doxygen/

There is a link to "Module Index" that leads to an error 404.

According to the doc it may be related to Python ? https://exhale.readthedocs.io/en/1.x/py-modindex.html

Also the legacy docs of exhale of the same exact issue: https://exhale.readthedocs.io/en/legacy_docs/

Can this be controlled in the conf.py somehow ? Or is it an exhale issue ?

svenevs commented 1 year ago

The module index is a little confusing from sphinx-quickstart. That's python only:

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#special-names

If you aren't documenting any python code (in addition to exhale) then you should remove it:

https://github.com/f3d-app/f3d/blob/gh-pages/doc/libf3d/doxygen/_sources/index.rst.txt#L26

Probably linking to the wrong branch or repo but wherever index.rst is (writing from a phone miles from a computer 🙃).

I would like to leave this open until I document a suggestion to remove that from the generated index.rst.