Skip to content

Comments

Docs: remove documentation of hidden modules#3350

Merged
snowman2 merged 1 commit intorasterio:mainfrom
adamjstewart:docs/hidden-modules
Jun 5, 2025
Merged

Docs: remove documentation of hidden modules#3350
snowman2 merged 1 commit intorasterio:mainfrom
adamjstewart:docs/hidden-modules

Conversation

@adamjstewart
Copy link
Contributor

@adamjstewart adamjstewart commented May 21, 2025

The following hidden modules have autodoc files, but aren't included in index.rst, meaning we waste time on generating webpages but never serve them. This results in the following warning in RtD CI:

/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._base.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._env.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._err.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._example.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._features.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._filepath.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._fill.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._io.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._loading.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._transform.rst: WARNING: document isn't included in any toctree [toc.not_included]
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/checkouts/3348/docs/api/rasterio._warp.rst: WARNING: document isn't included in any toctree [toc.not_included]

snowman2
snowman2 approved these changes May 21, 2025
View reviewed changes
Copy link
Member

@snowman2 snowman2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @adamjstewart 👍

@adamjstewart
Copy link
Contributor Author

adamjstewart commented May 30, 2025

@snowman2 @sgillies ready to merge?

@adamjstewart
Copy link
Contributor Author

adamjstewart commented Jun 5, 2025

Ping

@snowman2 snowman2 merged commit 0e78687 into rasterio:main Jun 5, 2025
1 check passed
@adamjstewart adamjstewart deleted the docs/hidden-modules branch June 5, 2025 12:29
@snowman2 snowman2 added documentation backport-1.4 To be backported to maint-1.4 labels Nov 6, 2025
@snowman2 snowman2 added this to the 1.4.4 milestone Nov 6, 2025
snowman2 pushed a commit that referenced this pull request Nov 6, 2025
@adamjstewart @snowman2
Docs: remove documentation of hidden modules (#3350)
2bef936
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@snowman2 snowman2 snowman2 approved these changes

Assignees

No one assigned

Labels

backport-1.4 To be backported to maint-1.4 documentation

Projects

None yet

Milestone

1.4.4

Development

Successfully merging this pull request may close these issues.

2 participants

@adamjstewart @snowman2