Repository navigation
docs: exclude tooling files from the published docs site - #2740
Merged
Merged
Conversation
MkDocs copies every non-Markdown file in docs_dir into the built site, so the docs Dockerfile and requirements files were published at the site root. Exclude them from the build. Fixes #2739
|
phipag
approved these changes
Nov 4, 2026
phipag
approved these changes
Nov 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
MkDocs copies every non-Markdown file in
docs/into the built site, so the docsDockerfileandrequirements.in/requirements.txtare published at the root of every docs version (e.g. https://docs.aws.amazon.com/powertools/java/latest/Dockerfile). This addsexclude_docstomkdocs.ymlfor/Dockerfileand/requirements.*so they're left out of the build.docs/, sodocker build ./docs/in the docs workflows is unaffecteddocs/Dockerfileand runningmkdocs buildas CI does, before and after the change: the only difference in the output is that the three files are goneIssue number: closes #2739
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.