CI: Unpin geopandas in the Docs workflow and manually register gdal drivers as workaround

[seisman]

Revert changes in #3304 so that we can track the issue #3301

[weiji14]

Found this issue geopandas/pyogrio#144 that mentions an error like pyogrio.errors.DataSourceError: Could not obtain driver: GPKG (check that it was installed correctly into GDAL) was due to drivers not being loaded properly. This should have been fixed in geopandas/pyogrio#145, but unsure why we're still hitting into this in the sphinx build and not in the regular tests.

Calling pyogrio.core._register_drivers() seems to get the GDAL drivers to register, so the build passes. But it doesn't look nice, and we should report this as a bug upstream if we can find a way to reproduce this outside of sphinx.

[seisman]

Can we move it to conf.py so that we don't have to repeat it in multiple gallery examples?

[weiji14]

Just tried locally, no it doesn't work if I put it in doc/conf.py.

[seisman]

I'm hesitating to merge this PR because (1) users may be confused about pyogrio.core._register_drivers(); (2) Users may still use geopandas v0.x and don't have pyogrio installed.

[weiji14]

Yeah, don't think it's a good option either. I just tried adding it to the Makefile and it doesn't work either.

The funny thing is, the examples/gallery/maps/choropleth_map.py example which also has a import geopandas as gpd line, and runs before the roads example, doesn't fail with the DataSourceError. If I move that choropleth_map.py file somewhere else, all the builds work without needing to register the driver manually 😅

[seisman]

In commit 9883359, I use sphinx-gallery's sphinx_gallery_start_ignore/sphinx_gallery_end_ignore flags to hide the two lines of codes in the documentation.

Preview:

1. https://pygmt-dev--3305.org.readthedocs.build/en/3305/gallery/lines/roads.html#sphx-glr-gallery-lines-roads-py
2. https://pygmt-dev--3305.org.readthedocs.build/en/3305/get_started/04_table_inputs.html#sphx-glr-get-started-04-table-inputs-py