Skip to content

docs: exclude tooling files from the published docs site - #8770

Merged
leandrodamascena merged 2 commits into
developfrom
docs/exclude-tooling-files-from-site
Nov 5, 2026
Merged

leandrodamascena merged 2 commits into
developfrom
docs/exclude-tooling-files-from-site

Conversation

@dreamorosi

Copy link
Copy Markdown
Contributor

Issue number: closes #8769

Summary

Changes

Add /Dockerfile and /requirements.* to exclude_docs in mkdocs.yml, so the local docs preview container and the docs dependency files stop being copied into the published site.

User experience

Before: Dockerfile, requirements.in and requirements.txt are reachable at the root of every docs version, e.g. https://docs.aws.amazon.com/powertools/python/latest/Dockerfile.
After: newly published versions don't include them. Pages and navigation are unchanged.

Verification

Ran zensical build (0.0.73, from docs/requirements.txt) on develop before and after the change. Before: the three files appear at the root of site/. After: they're gone, adr/ is still excluded, and the build reports no issues.

This PR was prepared with an AI coding assistant. I reviewed the change and the build output.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

The docs build copies every non-Markdown file in docs_dir into the site, so
the local preview Dockerfile and the docs requirements files were published at
the root of every docs version. Exclude them from the build.

Fixes #8769
@dreamorosi
dreamorosi requested a review from a team as a code owner November 4, 2026 17:23
@dreamorosi
dreamorosi requested a review from hjgraca November 4, 2026 17:23
@dreamorosi dreamorosi self-assigned this Nov 4, 2026
@powertools-for-aws-oss-automation powertools-for-aws-oss-automation Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 4, 2026
@dreamorosi
dreamorosi requested review from leandrodamascena and removed request for hjgraca November 4, 2026 17:28

@leandrodamascena leandrodamascena left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks Andrea! I checked and the Dockerfile is indeed live on the site right now, with your change it's gone from the build. Approving.

@leandrodamascena leandrodamascena added this to the 3.40.0 milestone Nov 5, 2026
@boring-cyborg boring-cyborg Bot added the documentation Improvements or additions to documentation label Nov 5, 2026
@sonarqubecloud

sonarqubecloud Bot commented Nov 5, 2026

Copy link
Copy Markdown

@leandrodamascena
leandrodamascena merged commit 181e863 into develop Nov 5, 2026
8 checks passed
@leandrodamascena
leandrodamascena deleted the docs/exclude-tooling-files-from-site branch November 5, 2026 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Maintenance: exclude docs tooling files from the published docs site

2 participants