sphinx_git: add 'repo-dir' in option_spec of GitCommitDetail #60
Conversation
This file contains hidden or 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
Add 'repo-dir' option in the option_spec of GitCommitDetail class. GitCommitDetail extends class GitDirectiveBase. GitDirectiveBase base class checks for 'repo-dir' option, with an environment default. 'repo-dir' option previously is in option_spec of GitChangelog but not of GitCommitDetail. If 'repo-dir' option is added to the option_spec, that option becomes functional for GitCommitDetail because the option is queried in GitDirectiveBase. 1 use of 'repo-dir' option with GitCommitDetail is to embed the git revision (by commit SHA) of a neighboring git repository which is documented by the Sphinx documents, importing doxygen comments from that neighboring git repository by Breathe extension.
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.
Add 'repo-dir' option in the option_spec of GitCommitDetail class.
GitCommitDetail extends class GitDirectiveBase. GitDirectiveBase base class checks for 'repo-dir' option, with an environment default.
'repo-dir' option previously is in option_spec of GitChangelog but not of GitCommitDetail.
If 'repo-dir' option is added to the option_spec, that option becomes functional for GitCommitDetail because the option is queried in GitDirectiveBase.
1 use of 'repo-dir' option with GitCommitDetail is to embed the git revision (by commit SHA) of a neighboring git repository which is documented by the Sphinx documents, importing doxygen comments from that neighboring git repository by Breathe extension.