Skip to content

Doc: gpkg "Performance Hints" link broken #10218

@pedros007

Description

@pedros007

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

  1. Load gpkg configuration options documentation
  2. Scroll to the section OGR_SQLITE_CACHE and OGR_SQLITE_SYNCHRONOUS, which says

see Performance hints.

  1. Click Performance Hints and the #target-drivers-vector-sqlite-performance-hints does not exist on gpkg.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:

- .. config:: OGR_SQLITE_CACHE
see :ref:`Performance hints <target_drivers_vector_sqlite_performance_hints>`.
- .. config:: OGR_SQLITE_SYNCHRONOUS
see :ref:`Performance hints <target_drivers_vector_sqlite_performance_hints>`.

and is referenced by the gpkg docs:

- :copy-config:`OGR_SQLITE_CACHE`
- :copy-config:`OGR_SQLITE_SYNCHRONOUS`

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.

Metadata

Metadata

Assignees

Labels

documentationIssues and contributions to the documentation content

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions