Add apidoc_separate_modules option #1
Merged
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
|
This would help keep Cinder docs consistent with the existing doc output. I have not had a chance to test it out yet, but the code looks good, and just want to state support for the idea. |
stephenfin
requested changes
Apr 3, 2018
sphinxcontrib/apidoc/__init__.py
Outdated
| app.add_config_value('apidoc_module_dir', None, 'env', [str]) | ||
| app.add_config_value('apidoc_output_dir', 'api', 'env', [str]) | ||
| app.add_config_value('apidoc_excluded_paths', [], 'env', [[str]]) | ||
| app.add_config_value('apidoc_separate_modules', False, 'env', [[bool]]) |
There was a problem hiding this comment.
s/[[bool]]/[bool]/
(this is a type check, and what's there means "list of bools" when I guess we just want a single bool)
There was a problem hiding this comment.
Went ahead and fixed this. Also added some tests along the way.
stephenfin
force-pushed
the
separate-modules
branch
from
b4efe16 to
9250edb
Compare
Give users the option to have apidoc generate a page-per-module instead of a page-per-package. Signed-off-by: Zane Bitter <zbitter@redhat.com> Signed-off-by: Stephen Finucane <stephen@that.guru>
stephenfin
force-pushed
the
separate-modules
branch
from
9250edb to
a1794bd
Compare
|
Awesome, thanks @stephenfin |
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.
Give users the option to have apidoc generate a page-per-module instead
of a page-per-package.