Remove ``include_patterns`` monkeypatching (#2810)

This is included in Sphinx core from version 5.1
This commit is contained in:
Adam Turner 2022-10-05 18:03:04 +01:00 committed by GitHub
parent 5fb8b28a06
commit 80c69055a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 41 deletions

View File

@ -8,11 +8,6 @@ import sys
sys.path.append(str(Path("pep_sphinx_extensions").absolute()))
# Add 'include_patterns' as a config variable
from sphinx.config import Config
Config.config_values["include_patterns"] = [], "env", []
del Config
# -- Project information -----------------------------------------------------
project = "PEPs"

View File

@ -6,7 +6,6 @@ from typing import TYPE_CHECKING
from docutils.writers.html5_polyglot import HTMLTranslator
from sphinx import environment
from sphinx import project
from pep_sphinx_extensions.pep_processor.html import pep_html_builder
from pep_sphinx_extensions.pep_processor.html import pep_html_translator
@ -18,37 +17,6 @@ from pep_sphinx_extensions.pep_zero_generator.pep_index_generator import create_
if TYPE_CHECKING:
from sphinx.application import Sphinx
from sphinx.config import Config
def find_files(self: environment.BuildEnvironment, config: Config, _b) -> None:
"""Find all pep source files."""
import fnmatch
from pathlib import Path
root = Path(self.project.srcdir).absolute()
self.project.docnames = set()
for pattern in config.include_patterns:
for path in root.glob(pattern):
filename = str(path.relative_to(root))
if any(fnmatch.fnmatch(filename, pattern) for pattern in config.exclude_patterns):
continue
doc_name = self.project.path2doc(filename)
if not doc_name:
continue
if doc_name not in self.project.docnames:
self.project.docnames.add(doc_name)
continue
other_files = [str(f.relative_to(root)) for f in root.glob(f"{doc_name}.*")]
project.logger.warning(
f'multiple files found for the document "{doc_name}": {other_files!r}\n'
f'Use {self.doc2path(doc_name)!r} for the build.', once=True)
environment.BuildEnvironment.find_files = find_files
def _depart_maths():

View File

@ -1,6 +1,6 @@
# Requirements for building PEPs with Sphinx
Pygments >= 2.9.0
Sphinx >= 4.0.2
Sphinx >= 5.1.1
docutils >= 0.19.0
# For RSS