gdal
gdal copied to clipboard
Doc: gpkg "Performance Hints" link broken
What is the bug?
The Performance Hints
link on the gpkg driver should go to the sqlite driver. However, it's broken.
Steps to reproduce the issue
- Load gpkg configuration options documentation
- Scroll to the section
OGR_SQLITE_CACHE
andOGR_SQLITE_SYNCHRONOUS
, which says
see Performance hints.
- Click
Performance Hints
and the#target-drivers-vector-sqlite-performance-hints
does not exist ongpkg.html
so nothing new is displayed.
The link goes to a target on gpkg.html
. However, the target should link to the sqlite.html
at https://gdal.org/drivers/vector/sqlite.html#target-drivers-vector-sqlite-performance-hints
Versions and provenance
Latest Docs
Additional context
I think the problem is the way the restructured text sets a CONFIG
on the sqlite docs:
https://github.com/OSGeo/gdal/blob/5481008668c818303c2b429b53860a2d787c189b/doc/source/drivers/vector/sqlite.rst?plain=1#L458-L464
and is referenced by the gpkg docs: https://github.com/OSGeo/gdal/blob/5481008668c818303c2b429b53860a2d787c189b/doc/source/drivers/vector/gpkg.rst?plain=1#L492-L494
You probably need an absolute link to the sqlite rather than relative... but I don't know how to make the change in a way that preserves cross-page reference in all cases.