Contributing to Docs?

[lapp0]

trafficstars

Hi,

I'd like to contribute a small section to the docs that I found helpful (using requests_cache so tiles don't take super long to load each run).

I don't see a repo for the documentation, nor do I see anything beyond the main page of https://contextily.readthedocs.io/ in the contextily repo. Are the docs auto-generated from github anywhere? Is there any documentation on how to contribute to contextily's docs?

Thanks!

[jorisvandenbossche]

That would be very welcome!

The actual content of the docs lives in the notebooks directory: https://github.com/geopandas/contextily/tree/master/notebooks (when building the docs, those are copied into the docs/ directory). We should probably add a README to the /docs directory to mention this.

Note that we have a set_cache_dir function that also helps with caching across python sessions (but this is also not included in the docs .. It was added here: https://github.com/geopandas/contextily/pull/106)

[lapp0]

Thanks. I have a second question. I see _providers.py is autogenerated. Would it be within the scope of this project to create a new module to allow for the inclusion of hardcoded USGS map servers?

https://basemap.nationalmap.gov/arcgis/rest/services

[jorisvandenbossche]

The first option is ideally to check if they can be added to leaflet-providers (from which our list is autogenerated), and if that's not possible, we can indeed have another script that adds some other hard-coded ones to the generated _providers.py file.

Now, I was quickly checking leaflet-providers, and it seems someone recently added some USGS providers: https://github.com/leaflet-extras/leaflet-providers/pull/367 Could you check if that are the services that you are interested in?

If so, we should re-generate the _providers.py with the latest leaflet-providers version to include those new (there will be other useful changes as well, probably)