Skip to content

Commit 27a4011

Browse files
committed
Switch to requirements.txt for readthedocs.
Bulleted lists were not rendering properly. Apparently, this is an old bug (readthedocs/sphinx_rtd_theme#1115) that has recently resurfaced. The solution is to pin newer versions of sphinx and sphinx_rtd_theme (https://stackoverflow.com/questions/67542699/readthedocs-sphinx-not-rendering-bullet-list-from-rst-file/71069918#71069918). However, readthedocs conda build environment does not allow pinning: readthedocs/readthedocs.org#3829 Thus, the only solution is to convert to a requirements.txt build on readthedocs. While configuring this build, I also updated to the latest system image, python version, and to a non-deprecated name for the readthedocs configuration file (https://docs.readthedocs.io/en/stable/config-file/v2.html).
1 parent a9234f5 commit 27a4011

File tree

3 files changed

+15
-18
lines changed

3 files changed

+15
-18
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
version: 2
22

3-
conda:
4-
environment: sphinx-doc/environment.yml
3+
python:
4+
install:
5+
- requirements: sphinx-doc/requirements.txt
56

67
sphinx:
78
configuration: sphinx-doc/conf.py
@@ -11,9 +12,9 @@ formats:
1112
- htmlzip
1213

1314
build:
14-
os: ubuntu-20.04
15+
os: ubuntu-22.04
1516
tools:
16-
python: mambaforge-4.10
17+
python: "3.11"
1718

1819
submodules:
1920
include: all

sphinx-doc/environment.yml

-14
This file was deleted.

sphinx-doc/requirements.txt

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
h5py
2+
ipython
3+
ipython_genutils
4+
nbconvert
5+
nbsphinx
6+
numpy
7+
pandoc
8+
sphinx>=4.3.0
9+
sphinx-rtd-theme>=0.5.1
10+
tornado

0 commit comments

Comments
 (0)