Fix auto doc for multiple projects (alternate) #899
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Requesting a review |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an alternate for #896.
I was reviewing the code closer and could not determine why the name was not updating, but discovered that the directory is used as the key instead of the project name. I believe the project name should be used in order to remain consistent with the dictionary within the
conf.py.In my case, I had multiple projects with the same directory (which may be a misuse on my part).
I have allowed for a fallback to the
source_pathif thenameis not available, although I couldn't think of a situation where the project name would not exist (but I am not extremely familiar with the entire project).P.S. I started investigating using the autodoxygen method to resolve an issue I'm having, which I will create an issue for, since I still can't seem to solve it.