-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
[docs] limit number of files to scan for autosummary generation and reorganize conf.py #2297
Conversation
docs/conf.py
Outdated
@@ -81,12 +81,12 @@ def run(self): | |||
"show-inheritance": True, | |||
} | |||
|
|||
# Generate autosummary pages. Output should be set with: `:toctree: pythonapi/` | |||
autosummary_generate = ['Python-API.rst'] | |||
|
|||
# Add any paths that contain templates here, relative to this directory. | |||
templates_path = ['_templates'] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The only change I would suggest is moving these lines back below the templates_path
variable to keep the diffs smaller.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hayesall Thanks for your review! I moved autosummary_generate
variable with the aim to keep logic grouping: autodoc_*
variables are closer to autosummary_*
and templates_path
is closer to source_suffix
, so the first group is about auto_
extensions and the second one is about source file paths.
IDK, maybe you're right and smaller diff is more important than grouping. Let's wait for one more opinion from another reviewer...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@StrikerRUS Logical ordering is more important small diffs, I like this now that I see it this way 👍
While we're on the subject: it doesn't appear that templates are used in this repository, so we could drop the templates_path
variable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Refer to #2286 (comment).
Before:
Now:
@hayesall Can you please give your review?
UPD: Also, group options in
conf.py
logically.