Skip to content

Infra: Exclude .git directory from Sphinx processing #2423

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

Closed
wants to merge 1 commit into from

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Mar 12, 2022

For #2404 (comment).

Whichever of #2405 and #2415 we choose, we definitely don't want Sphinx to process the contents of the .git directory. Let's explicitly exclude it.

@hugovk hugovk added the infra Core infrastructure for building and rendering PEPs label Mar 12, 2022
@hugovk hugovk requested a review from CAM-Gerlach March 12, 2022 09:08
@hugovk hugovk requested a review from AA-Turner as a code owner March 12, 2022 09:08
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#2405 didn't previously fully address this case, but as it would cause a merge conflict accepting this, I added this line there.

#2415 already addresses this (and this will also cause a merge conflict there), as it only attempts to read rst files from directories beginning with pep- with four following characters (and with my requested enhancement, more precisly only pep-NNNN directories as specified in PEP 1/PEP 12. Therefore, .git is naturally excluded, as is everything else on the current exclude list save the PEP template.

As such, it seems this PR isn't needed if either of those are merged (and conflicts with them), so merging this is only necessary if we want a very short term stopgap.

@hugovk
Copy link
Member Author

hugovk commented Mar 12, 2022

Thanks, let's close this then!

@hugovk hugovk closed this Mar 12, 2022
@hugovk hugovk deleted the exclude-git branch May 7, 2022 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA signed infra Core infrastructure for building and rendering PEPs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants