Skip to content

Commit 8045ffe

Browse files
authored
fixed rtd issue (#477)
* fixed regression in read the docs builds
1 parent 81941f6 commit 8045ffe

3 files changed

Lines changed: 25 additions & 19 deletions

File tree

.readthedocs.yml renamed to .readthedocs.yaml

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,19 @@
22
# Read the Docs configuration file
33
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
44

5-
build:
6-
image: stable
7-
85
# Required
96
version: 2
107

8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "mambaforge-22.9"
12+
13+
# use a conda environment
14+
conda:
15+
environment: docs/environment.yml
16+
17+
1118
# Build documentation in the docs/ directory with Sphinx
1219
sphinx:
1320
configuration: docs/conf.py
@@ -18,12 +25,7 @@ formats:
1825
- epub
1926
- pdf
2027

21-
# use a conda environment
22-
conda:
23-
environment: docs/environment.yml
24-
2528
python:
26-
version: 3.11
27-
install:
28-
- method: pip
29-
path: .
29+
install:
30+
- method: pip
31+
path: .

‎docs/conf.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
"sphinx.ext.inheritance_diagram",
4040
"sphinx_copybutton",
4141
"myst_parser",
42+
'sphinx_rtd_theme',
4243
]
4344

4445
# conf for copybutton
@@ -112,7 +113,7 @@
112113

113114
# The theme to use for HTML and HTML Help pages. See the documentation for
114115
# a list of builtin themes.
115-
html_theme = "default"
116+
html_theme = "sphinx_rtd_theme"
116117

117118
# Theme options are theme-specific and customize the look and feel of a theme
118119
# further. For a list of options available for each theme, see the

‎docs/environment.yml‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,15 @@ channels:
55
- nodefaults
66

77
dependencies:
8-
- python=3.11
9-
- numpy
10-
- sphinx>=3.1.2
11-
- myst-parser
8+
- python=3.10
9+
- numpy==1.25.2
10+
- myst-parser==2.0.0
11+
- docutils
12+
- graphviz
13+
- sphinx<=7.0.0
1214
- sphinx-copybutton
15+
- sphinx-autodoc-typehints
16+
- recommonmark
1317
- pip
14-
- pip:
15-
- sphinx_autodoc_typehints
16-
18+
variables:
19+
CONDA_APPEND_CORE_REQUIREMENTS: False

0 commit comments

Comments
 (0)