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

Fix #10057: Failed to scan documents on the root directory #10068

Merged
merged 1 commit into from Jan 11, 2022

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Jan 8, 2022

Feature or Bugfix

  • Bugfix

Purpose

  • get_matching_files() incorrectly drops the first character of each
    path on scanning documents. It will help users to exclude paths
    via exclude_patterns setting.
  • Note: Users need to configure exclude_patterns to put their document
    on the root directory. This does not help to avoid recursive symlinks
    (ex. /proc, /sys)
  • refs: Sphinx fails out when run at root directory inside of a container #10057

@tk0miya tk0miya added this to the 4.4.0 milestone Jan 8, 2022
@tk0miya tk0miya force-pushed the 10057_scanning_docs_on_root branch from 1190a8e to 5838017 Compare January 8, 2022 18:54
get_matching_files() incorrectly drops the first character of each
path on scanning documents.  It will help users to exclude paths
via exclude_patterns setting.

Note: Users need to configure `exclude_patterns` to put their document
on the root directory.  This does not help to avoid recursive symlinks
(ex. /proc, /sys)
@tk0miya tk0miya force-pushed the 10057_scanning_docs_on_root branch from 5838017 to ce99cd4 Compare January 8, 2022 18:58
@tk0miya tk0miya merged commit 3ed9265 into sphinx-doc:4.x Jan 11, 2022
@tk0miya tk0miya deleted the 10057_scanning_docs_on_root branch January 11, 2022 17:42
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant