search

svenevs / exhale

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

Add support for manual indexing #177

Closed svenevs closed 2 years ago

svenevs commented 2 years ago

Closes #176. @IceflowRE can you take a look and see if this works for you? I have not tested this yet. Outside feedback welcome.

just an option that wont add the .include suffix

I understand it's a little more inconvenient but see the newly added options in configs.py. Docs on manual indexing in configs.rst hopefully gives a little more context, my understanding is you just wanted specific hierarchies but not the unabridged api or orphans (if relevant).

The other thing that came to mind was like hierarchyFileExtension = ".rst.include" and then you would only need to set one, but then there might be somebody who only wants say the page or the class hierarchy but not the others (?).

and do not generate the rootFileName file?

That one should work by setting rootFileName to "EXCLUDE" now.

Open to suggestions, I'm happy to expose more of the internals for projects to hack around -- exhale is one giant hack.

IceflowRE commented 2 years ago

In my tests the EXCLUDE value did not work.

sphinx.errors.ConfigError: The given rootFileName ("EXCLUDE") did not end with '.rst'; Exhale is reStructuredText only.

The other things works as expected! Thank you.

svenevs commented 2 years ago

In my tests the EXCLUDE value did not work.

Sorry about that... I knew I needed to add actual tests but hey for an untested stab the implementation was pretty close ^^ That should work as expected.

The other things works as expected! Thank you.

Thanks for testing, sorry for the delay on finalizing. The testing framework has ... issues. This stuff is released on 0.3.6 now.

IceflowRE commented 2 years ago

Thanks for the fast response! :D hey for Open Source this is fast!