You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 to cwd and due to this it does not find the file at all.
Example error:
Running Sphinx v4.3.2
/roc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
^C
Interrupted!
make: *** [Makefile:20: html] Interrupt
root@38d46495819d:/#
Example index.rst
.. dsa documentation master file, created by
sphinx-quickstart on Thu Jan 6 18:42:52 2022.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to dsa's documentation!
===============================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
root@38d46495819d:/# ```
### How to Reproduce
1. docker pull python:latest
2. podman run -it --entrypoint bash docker.io/python
3. pip3 install sphinx
4. sphinx-quickstart
5. fill in values recieve this output
```Creating file /conf.py.
Creating file /index.rst.
Creating file /Makefile.
Creating file /make.bat.
Finished: An initial directory structure has been created.
You should now populate your master file /index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.
run make html
root@38d46495819d:/# make html
Running Sphinx v4.3.2
making output directory... done
/roc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
/roc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/proc/1/cwd/index.rst: WARNING: document not readable. Ignored.
^C
Interrupted!
make: *** [Makefile:20: html] Interrupt
root@38d46495819d:/#
Expected behavior
After running make html
[tester@test containers]$ make html
Running Sphinx v4.3.0
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
generating indices... genindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
The HTML pages are in _build/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:
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 exclude_patterns setting.
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)
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)
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: