[Python-checkins] Docs: don't render files in includes/, they're for embedding only (GH-103313)

miss-islington webhook-mailer at python.org
Tue Apr 11 02:26:14 EDT 2023


https://github.com/python/cpython/commit/a836d7911193752d5fa27e3f101941ab339bd986
commit: a836d7911193752d5fa27e3f101941ab339bd986
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2023-04-10T23:26:07-07:00
summary:

Docs: don't render files in includes/, they're for embedding only (GH-103313)

(cherry picked from commit 280bd536b58d3e844047cd132159cf9f6cb66708)

Co-authored-by: Hugo van Kemenade <hugovk at users.noreply.github.com>

files:
M Doc/conf.py

diff --git a/Doc/conf.py b/Doc/conf.py
index 982d6b40f66e..18aff5d58ce8 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -63,8 +63,10 @@
 # Minimum version of sphinx required
 needs_sphinx = '3.2'
 
+# Ignore any .rst files in the includes/ directory;
+# they're embedded in pages but not rendered individually.
 # Ignore any .rst files in the venv/ directory.
-exclude_patterns = ['venv/*', 'README.rst']
+exclude_patterns = ['includes/*.rst', 'venv/*', 'README.rst']
 venvdir = os.getenv('VENVDIR')
 if venvdir is not None:
     exclude_patterns.append(venvdir + '/*')



More information about the Python-checkins mailing list