-
-
Notifications
You must be signed in to change notification settings - Fork 677
docs on readthedocs aren't showing some standard features #1516
Copy link
Copy link
Closed
Labels
Description
Our docs on readthedocs seem to be missing a couple of things that usually show up:
- PR builds don't show a warning banner (https://docs.readthedocs.io/en/stable/pull-requests.html)
- The mentions of github aren't shown on pages and in the flyout menu. Compare with https://rules-testing.readthedocs.io/en/latest/index.html ("Edit on github" at the top right", the flyout menu has a "Github: view/edit" link)
Not sure why. I'm guessing it's because Bazel is handling everything instead of readthedocs. Usually with readthedocs, the config file specifies:
- python version to use
- requirements file to install
- Sphinx config file being used
- Specific formats to build
And this gets translated into various pip install and sphinx-build commands.
e.g. here's some of the build log from rules_testing, which uses the readthedocs.yml config file:
python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
python -m pip install --upgrade --no-cache-dir pip setuptools
python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext
python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
npm install -g @bazel/bazelisk
bazel run //docs:run_sphinx_build
cat docs/source/conf.py
python -m sphinx -T -E -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
python -m sphinx -T -E -b readthedocssinglehtmllocalmedia -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/htmlzip
python -m sphinx -T -E -b latex -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/pdf
cat latexmkrc
latexmk -r latexmkrc -pdf -f -dvi- -ps- -jobname=rules-testing -interaction=nonstopmode
Maybe it also has to do with the environment variables? I noticed that environment variables aren't passed through to the actions.run call for running Sphinx. Which is WAI as far as bazel is concerned, but maybe there is logic within one of the sphinx extensions that checks for those to activate special behavior.
Reactions are currently unavailable