-
-
Notifications
You must be signed in to change notification settings - Fork 18.1k
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
DOC: Adding header to the rst files that don't have it #24191
Conversation
Codecov Report
@@ Coverage Diff @@
## master #24191 +/- ##
==========================================
- Coverage 92.21% 92.21% -0.01%
==========================================
Files 162 162
Lines 51723 51723
==========================================
- Hits 47695 47694 -1
- Misses 4028 4029 +1
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #24191 +/- ##
=======================================
Coverage 92.21% 92.21%
=======================================
Files 162 162
Lines 51723 51723
=======================================
Hits 47695 47695
Misses 4028 4028
Continue to review full report at Codecov.
|
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.
(I would personally find it a bit cleaner to have a separate "common header" and "common imports", as they are used for different purposes, but doesn't matter much :-), and is more work to have it in all pages)
…e header in api.rst, and it's not detected by the validation script
Hello @datapythonista! Thanks for updating the PR.
|
Didn't think about it. It could make sense in pages with no examples (e.g. We can always go back to it. But for now, besides making the imports simpler and more consistent, it allows me to set the |
When using the new style for the pandas documentation, we'll be using the
{{ header }}
context to set the:tocdepth:
of all pages (sphinx does not have a setting to set all the:tocdepth:
at once).In #24086 we added to most
.rst
files the header, that it's also used to import pandas and numpy, and set some settings. Adding it to the pages that don't have it yet.