Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add include_patterns as the opposite of exclude_patterns #10518

Merged
merged 10 commits into from Jul 17, 2022

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Jun 3, 2022

Currently Sphinx walks the source directory recursivley, looking for files. This is useful when documentation sources are in a distinct Documentation or etc folder, but for projects like the PEPs where the project is the documentation, it is more useful to specify which files we want to include.

This adds an implementation which by default works exactly the same as today, but allows configuring include_paths.

Feature or Bugfix

  • Feature

A

@AA-Turner AA-Turner self-assigned this Jun 3, 2022
@AA-Turner AA-Turner added type:enhancement enhance or introduce a new feature internals:config labels Jun 3, 2022
@AA-Turner AA-Turner added this to the 5.1.0 milestone Jun 3, 2022
AA-Turner and others added 3 commits June 4, 2022 00:06
# Conflicts:
#	doc/extdev/deprecated.rst
#	sphinx/templates/quickstart/conf.py_t
@AA-Turner AA-Turner marked this pull request as ready for review July 17, 2022 20:37
@AA-Turner AA-Turner merged commit 490a8a9 into sphinx-doc:5.x Jul 17, 2022
AA-Turner added a commit that referenced this pull request Jul 17, 2022
sphinx/util/matching.py Show resolved Hide resolved
sphinx/util/matching.py Show resolved Hide resolved
sphinx/directives/other.py Show resolved Hide resolved
doc/usage/configuration.rst Show resolved Hide resolved
@tk0miya
Copy link
Member

tk0miya commented Jul 18, 2022

Sorry for the late review. But it would be better to refine this. +1 for adding this configuration.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 18, 2022
@AA-Turner AA-Turner deleted the include-patterns branch March 30, 2023 15:05
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
internals:config type:enhancement enhance or introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants