Skip to content

Docs: Revert dynamic exclude_patterns #12434

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

Merged
merged 1 commit into from
May 21, 2025

Conversation

geographika
Copy link
Collaborator

This PR rolls back the change added in #12315 as this broke incremental builds.

I closed #12419 which attempted to exclude one of the indexes based on the build type. It was beoming overly complex with little benefit.

The messages index.rst: document is referenced in multiple toctrees: ['index', 'index_pdf'], selecting: index_pdf <- api/index are INFO so not warnings. If they had been warnings, they could be silenced in conf.py using:

suppress_warnings = [
    "toc.multiple_toc_parents",  # Suppresses "document is referenced in multiple toctrees"
]

cc @dbaston

@rouault rouault merged commit 18a0b9c into OSGeo:master May 21, 2025
1 of 2 checks passed
@DelazJ
Copy link
Collaborator

DelazJ commented May 21, 2025

@geographika I didn't look into the details but did you try embedding the files contents under .. only:: latex for one and .. only:: not latex for the other (and maybe with :orphan: in both)?

@geographika
Copy link
Collaborator Author

@geographika I didn't look into the details but did you try embedding the files contents under .. only:: latex for one and .. only:: not latex for the other (and maybe with :orphan: in both)?

Thanks for the suggestion @DelazJ but I still get the gdal\doc\source\api\index.rst: document is referenced in multiple toctrees: ['index', 'index_pdf'], selecting: index_pdf <- api/index messages even with the following in index_pdf.rst:

:orphan:

.. only:: latex

It looks like it might only be solved with a patch to Sphinx.

@geographika
Copy link
Collaborator Author

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

Successfully merging this pull request may close these issues.

3 participants