- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Sphinx fails out when run at root directory inside of a container #10057
Labels
Milestone
Comments
Indeed, the first characters of the paths are surely dropped when you put a Sphinx project onto the root directory. It must be a bug. |
NOTE: I don't think it's nonsense to support the Sphinx project placed on the root directory. So I'll only fix the bug that Sphinx incorrectly drops the first character of each path on scanning documents. It will help users to exclude paths via |
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Jan 8, 2022
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
added a commit
to tk0miya/sphinx
that referenced
this issue
Jan 8, 2022
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
added a commit
that referenced
this issue
Jan 11, 2022
Fix #10057: Failed to scan documents on the root directory
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Bug Description
Attempting to local test container builds for sphinx documentation I ran across an issue where after completing QuickStart and attempting to run make html you get returned the following error. It appears that it fails to grab the intial
p
in/proc
before attempting to navigate tocwd
and due to this it does not find the file at all.Example error:
Example index.rst
make html
Expected behavior
After running make html
Your project
N/A
Screenshots
OS
Debian GNU/Linux 11
Python versions
3.10.1, 3.9.2, 3.8.1
Sphinx version
4.3.2
Sphinx extensions
No response
Extra tools
No response
Additional context
I would like to note that it generally it is not a good idea to normally install to root. Whether that be a warn or a documentation change.
The text was updated successfully, but these errors were encountered: