-
Notifications
You must be signed in to change notification settings - Fork 787
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
Address Sphinx warnings #2758
Address Sphinx warnings #2758
Conversation
…them not appearing in any toctree
843bc48
to
5272420
Compare
I'll use this comment to explain the reasoning behind pinning setuptools to < 64 and will add a link to it in the pyproject.toml file so it's easier to revisit this decision in the future. The PR pypa/setuptools#3265 (released in version 64) changed how Python packages are installed by setuptools in editable mode. This change, presumably unintentionally, has the side effect that When using setuptools >= 64 you'll see the following errors in the console when building the docs:
And the resulting page will look like this: After pinning setuptools to < 64 it works again: This decision should be revisited in the future. Somewhat related discussion: scikit-build/scikit-build#740 |
Commit 7ef558d fixes docstrings where attributes had multiple types which were wrapped onto a new line.
Sphinx renders this as if After the fix, these lines are no longer wrapped in the code:
and therefore render ok in the docs (the line break below is due to the width of the page but you can see that the formatting changed): |
…els as well as core (low-level)
041a7c4
to
17f71e8
Compare
I fixed various formatting issues in the docs as well as upstream in the docstring generation. For me the docs now build with only 1 warning left (see below) which is very satisfying! :) PR is ready for review and can also be merged without addressing the comment below. @mattijn The remaining warning is |
…fer to documentation as that section was not maintained
…vailable for the build workflow
This PR suppress the following warning to use a projected CRS for geometric computations. ``` <string>:3: UserWarning: Geometry is in a geographic CRS. Results from 'centroid' are likely incorrect. Use 'GeoSeries.to_crs()' to re-project geometries to a projected CRS before this operation. ``` For the given example we only need a _visual_ centroid and not an _exact_ centroid so this merely promotes good practice than being a necessity.
Looks great @binste! # The contents of this file are automatically written by
# tools/generate_schema_wrapper.py. Do not modify directly. |
Yep that's already the case. I made all those changes by modifying and then running |
Ah, I was expecting to see changes in |
Indeed, sorry for the confusion! |
I get quite a few warnings from Sphinx when building the docs. I'll try to address them in this PR. It's not ready yet to be merged but wanted to provide visibility that I'm working on this so we're not duplicating efforts
Parser.setup_parse
. this worked with previous parser. set it explicitly else raw html content won't show up which it should. E.g. it would show up as although that span should be blue:-
instead of*
/workspaces/altair/doc/user_guide/generated/toplevel/altair.Chart.rst:: ERROR: Anonymous hyperlink mismatch: 2 references but 0 targets. See "backrefs" attribute for IDs.
schema_description:9: ERROR: Unknown target name: "types#datetime".