tox -e docs not making index.html #3037
Description
Issue
Just sharing some hiccups encountered with tox developers setup.
First hiccup is the development guide should have pip install tox or pip install -e ., as it's required to be able to run tox -e docs. The Setup section mentions using pipx to install tox, but imo the guide should just have pipx install tox.
Next, when I run tox -e docs as documented in Building documentation, and index.html is not showing up in docs_out.
What I see is:
.tox/docs_out
├── output.json
└── output.txt
Environment
Provide at least:
- OS: macOS Monterey version 12.6
pip listof the host Python wheretoxis installed:
Package Version
------------- -------
cachetools 5.3.1
chardet 5.1.0
colorama 0.4.6
distlib 0.3.6
filelock 3.12.2
packaging 23.1
pip 23.0.1
platformdirs 3.5.3
pluggy 1.0.0
pyproject-api 1.5.2
setuptools 65.5.0
tomli 2.0.1
tox 4.6.2
virtualenv 20.23.1Output of running tox
Provide the output of tox -rvv:
Minimal example
If possible, provide a minimal reproducer for the issue:
tox -e docsWhich runs
sphinx-build -d /path/to/code/tox/.tox/docs/tmp/doctree docs /path/to/code/tox/.tox/docs_out --color -b html -b linkcheck -W
python -c 'print(r"documentation available under file:///path.to/code/tox/.tox/docs_out/index.html")'Which outputs:
( development: line 138) ok https://www.kessler.de/prd/smartbear/BestPracticesForPeerCodeReview.pdf
( index: line 4) ok https://www.devpi.net
build succeeded.
Look for any errors in the above output or in .tox/docs_out/output.txt
docs: commands[1]> python -c 'print(r"documentation available under file:///path/to/code/tox/.tox/docs_out/index.html")'
documentation available under file:///path/to/code/tox/.tox/docs_out/index.html
.pkg: _exit> python /path/to/.pyenv/versions/3.10.11/lib/python3.10/site-packages/pyproject_api/_backend.py True hatchling.build
docs: OK (28.41=setup[0.83]+cmd[27.55,0.03] seconds)
congratulations :) (28.55 seconds)