-
Notifications
You must be signed in to change notification settings - Fork 51
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
Add support for manual indexing #177
Conversation
In my tests the
The other things works as expected! Thank you. |
c0849a8
to
cefe84d
Compare
First failing in CI in #177, may become a future doxygen problem.
First failing in CI in #177, may become a future doxygen problem.
First failing in CI in #177, may become a future doxygen problem.
First failing in CI in #177, may become a future doxygen problem.
- Allow the root api file generation to be skipped. - Allow ``.rst.include`` behavior to be modified. - Release 0.3.6.
cefe84d
to
59f2476
Compare
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.
Thanks for testing, sorry for the delay on finalizing. The testing framework has ... issues. This stuff is released on 0.3.6 now. |
Thanks for the fast response! :D hey for Open Source this is fast! |
.rst.include
behavior to be modified.Closes #176. @IceflowRE can you take a look and see if this works for you? I have not tested this yet. Outside feedback welcome.
I understand it's a little more inconvenient but see the newly added options in
configs.py
. Docs on manual indexing inconfigs.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 (?).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.