Docs: don't render files in includes/, they're for embedding only#103313
Merged
hugovk merged 1 commit intopython:mainfrom Apr 11, 2023
Merged
Docs: don't render files in includes/, they're for embedding only#103313hugovk merged 1 commit intopython:mainfrom
hugovk merged 1 commit intopython:mainfrom
Conversation
zware
approved these changes
Apr 10, 2023
Contributor
|
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11. |
|
GH-103433 is a backport of this pull request to the 3.11 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Apr 11, 2023
…thonGH-103313) (cherry picked from commit 280bd53) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
warsaw
pushed a commit
to warsaw/cpython
that referenced
this pull request
Apr 11, 2023
aisk
pushed a commit
to aisk/cpython
that referenced
this pull request
Apr 18, 2023
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
4 participants
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.
Before
wasi<no title>page first:<no title>, it shows https://docs.python.org/3/includes/wasm-notavail.html?highlight=wasi:That's https://github.com/python/cpython/blob/main/Doc/includes/wasm-notavail.rst which is not meant to be rendered as a standalone page.
Instead it is meant to be embedded into pages via:
For example:
So let's exclude files in
includes/from being rendered individually by adding it toexclude_patterns.After
wasi<no title>page first:There is no
<no title>result and there is no standalone https://deploy-preview-103313--python-cpython-preview.netlify.app/includes/wasm-notavail.html?highlight=wasiThe include is still embedded on pages such as https://deploy-preview-103313--python-cpython-preview.netlify.app/library/venv.html?highlight=wasi