Skip to content
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

Projections not documented anymore #2004

Closed
maxnoe opened this issue Feb 14, 2022 · 7 comments
Closed

Projections not documented anymore #2004

maxnoe opened this issue Feb 14, 2022 · 7 comments

Comments

@maxnoe
Copy link

maxnoe commented Feb 14, 2022

Description

Older documentation versions had a nice list and gallery of the different projections available in cartopy.crs. The current documentation does not list any of these and seems to e.g. explicitly remove the projections from the documentation here:

__document_these__ = ['CRS', 'Geocentric', 'Geodetic', 'Globe']

It would be nice to at least document the projection classes, even better would be bringing back the nice gallery page showing off all the projections.

Cartopy version

Current release version and dev docs

@maxnoe maxnoe changed the title Projections not documented any Projections not documented anymore Feb 14, 2022
@greglucas
Copy link
Contributor

@maxnoe
Copy link
Author

maxnoe commented Feb 14, 2022

Is this page ever linked to from the toplevel?

https://scitools.org.uk/cartopy/docs/latest/reference/projections.html

@maxnoe
Copy link
Author

maxnoe commented Feb 14, 2022

Yes, it is, but the link is called PlateCarree, not Projections or Gallery of Projections:

Screenshot_20220214_161518

@maxnoe
Copy link
Author

maxnoe commented Feb 14, 2022

And the reason I didn't see the list of projections is that google brought me directly here:

https://scitools.org.uk/cartopy/docs/latest/reference/generated/cartopy.crs.CRS.html#cartopy.crs.CRS

@maxnoe
Copy link
Author

maxnoe commented Feb 14, 2022

So maybe just fixing the name of the link in the sidebar would have been enough. But why not include all the classes in the auto-generated API docs? Google seems to like referring people to that

@greglucas
Copy link
Contributor

The title issue looks like it is already fixed: #1983

I'm not sure I follow the suggestion about including all of the classes. They are all auto-generated in that list I think (right-hand side bar). See here for a recent docs build:
https://3048-5282596-gh.circle-artifacts.com/0/docs/build/html/reference/projections.html

@maxnoe
Copy link
Author

maxnoe commented Feb 14, 2022

Ok, thanks, indeed that looks ok, sorry for the noise.

That page also has a link to the "List of Projections" on the main page, not only the individual links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants