-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Splitting api.rst in several files #24462
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
Conversation
Codecov Report
@@ Coverage Diff @@
## master #24462 +/- ##
==========================================
- Coverage 92.3% 92.29% -0.01%
==========================================
Files 163 163
Lines 51969 51969
==========================================
- Hits 47968 47967 -1
- Misses 4001 4002 +1
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #24462 +/- ##
=======================================
Coverage 92.31% 92.31%
=======================================
Files 166 166
Lines 52412 52412
=======================================
Hits 48382 48382
Misses 4030 4030
Continue to review full report at Codecov.
|
I'm not sure what would be wrong with the autosummary. Your description sounds correct. |
@TomAugspurger looks like the problem with the paths is indeed caused by setting the list of |
This is looking good now, I think it can be merged. In this PR I just did the splitting without making any other change (more than standardizing blank lines, and the currentmodule directive). A small change to the validation script was needed to keep it working, which is implemented here (at the very end of the changes). In a follow up I'll propose changes to the titles of some pages, but I don't want to implement them here, as this is difficult to review, and I think it's better to not change any content here. There are some warnings, but none is introduced here, I'll keep taking care of them in separate PRs. This is how the new API main page looks like: And this is a sample of one of the individual pages: |
LGTM. Maybe wait till later today to merge in case other's have comments. We might want to rethink some of the organization / section headings (e.g. "general functions" isn't especially informative) but those can be done as followups. |
yeah this is ok. sure we need some work on the names / maybe some org of this, but a great first step. |
* upstream/master: DOC: Fixing broken references in the docs (pandas-dev#24497) DOC: Splitting api.rst in several files (pandas-dev#24462) Fix misdescription in escapechar (pandas-dev#24490) Floor and ceil methods during pandas.eval which are provided by numexpr (pandas-dev#24355) BUG: Pandas any() returning false with true values present (GH pandas-dev#23070) (pandas-dev#24434) Misc separable pieces of pandas-dev#24024 (pandas-dev#24488) use capsys.readouterr() as named tuple (pandas-dev#24489) REF/TST: replace capture_stderr with pytest capsys fixture (pandas-dev#24496) TST- Fixing issue with test_parquet test unexpectedly passing (pandas-dev#24480) DOC: Doc build for a single doc made much faster, and clean up (pandas-dev#24428) BUG: Fix+test timezone-preservation in DTA.repeat (pandas-dev#24483) Implement reductions from pandas-dev#24024 (pandas-dev#24484)
…strings * upstream/master: TST: Skip db tests unless explicitly specified in -m pattern (pandas-dev#24492) Mix EA into DTA/TDA; part of 24024 (pandas-dev#24502) DOC: Fix building of a single API document (pandas-dev#24506) DOC: Fixing broken references in the docs (pandas-dev#24497) DOC: Splitting api.rst in several files (pandas-dev#24462) Fix misdescription in escapechar (pandas-dev#24490) Floor and ceil methods during pandas.eval which are provided by numexpr (pandas-dev#24355) BUG: Pandas any() returning false with true values present (GH pandas-dev#23070) (pandas-dev#24434) Misc separable pieces of pandas-dev#24024 (pandas-dev#24488) use capsys.readouterr() as named tuple (pandas-dev#24489) REF/TST: replace capture_stderr with pytest capsys fixture (pandas-dev#24496) TST- Fixing issue with test_parquet test unexpectedly passing (pandas-dev#24480) DOC: Doc build for a single doc made much faster, and clean up (pandas-dev#24428) BUG: Fix+test timezone-preservation in DTA.repeat (pandas-dev#24483) Implement reductions from pandas-dev#24024 (pandas-dev#24484)
git diff upstream/master -u -- "*.py" | flake8 --diff
@TomAugspurger do you know why moving the api
autosummary
to a directory, make the build not find the generated files? For what I understand, the:toctree: generated/
is used for both, to know where to generate the API files, and later on to link them. But it looks like they are generated ingenerated/
, but then I get warnings because sphinx is looking for them inapi/generated/
.There was something a bit tricky in the
autosummary_generate
option that I removed in #24428 (it's not yet merged), but I don't see anything in the configuration that can be causing this behavior (and I've seen other projects using autosummaries in directories without problems, like https://github.com/bradgwest/esof523a3/tree/master/doc/reference).