[FR] INCLUDE_PATTERN for apidoc
#12313
abravalheri
started this conversation in
Feature requests and ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Is your feature request related to a problem? Please describe.
Currently you can pass
EXCLUDE_PATTERNtosphinx-apidocand that is very good to prevent documentation to be generated for modules that are not intended. This is nice when the majority of the modules is intended for public consumption but there are a few exceptions.However it can be very frustrating when the code-base works on the other way around: the majority of the modules are not intended for public consumption but there are a few that should be documented.
For example, consider a package where all the modules intended for public consumption are names
*_api.pyand the author wantssphinx-apidocto only generate documentation for them.Describe the solution you'd like
Add a
INCLUDE_PATTERNargument/option tosphinx-apidocDescribe alternatives you've considered
I tried to mess around a bit with
autogen, but it does not have the same functionality as the suggestion.Beta Was this translation helpful? Give feedback.
All reactions