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

Add support for manual indexing #177

Merged
merged 1 commit into from
Oct 2, 2022
Merged

Add support for manual indexing #177

merged 1 commit into from
Oct 2, 2022

Conversation

svenevs
Copy link
Owner

@svenevs svenevs commented Sep 17, 2022

  • Allow the root api file generation to be skipped.
  • Allow .rst.include behavior to be modified.
  • Release 0.3.6.

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
Copy link
Contributor

IceflowRE commented Sep 18, 2022

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 added a commit that referenced this pull request Oct 2, 2022
First failing in CI in #177, may become a future doxygen problem.
svenevs added a commit that referenced this pull request Oct 2, 2022
First failing in CI in #177, may become a future doxygen problem.
svenevs added a commit that referenced this pull request Oct 2, 2022
First failing in CI in #177, may become a future doxygen problem.
svenevs added a commit that referenced this pull request Oct 2, 2022
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.
@svenevs svenevs merged commit 9a6138e into master Oct 2, 2022
@svenevs svenevs deleted the feat/manual-indexing branch October 2, 2022 22:29
@svenevs
Copy link
Owner Author

svenevs commented Oct 2, 2022

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
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow root file to be excluded and set filename of hierarchy files
2 participants