-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
DOC: fix API docs generation with sphinx 1.6 #16705
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Comments
@TomAugspurger this doesn't need to be fixed for 0.20.3 I think, but just have to remember to build the docs with 1.5* then, therefore tagging it for now as 0.20.3. |
Running the api docs locally with latest sphinx 1.6.5. Some observations:
|
Regarding the extra warnings: the methods/attributes for which we get a new warning all seem to be methods/attributes that are not listed somewhere in the api.rst page. For the slowdown I opened an issue on sphinx: sphinx-doc/sphinx#4230 |
Again about the warnings, I was a bit too quick: after reading there is indeed only a limited number of warnings (as explained above), but after writing many warnings for all methods/attributes like ":: WARNING: toctree contains reference to nonexisting document 'generated/pandas.Timestamp.week' " |
See discussion #16702 (comment). Pinned sphinx to 1.5* for now (#16704)
The text was updated successfully, but these errors were encountered: