Skip to content

Commit 89aa50d

Browse files
authored
Update readthedocs to new yaml for testing. (#40)
1 parent a3a4a65 commit 89aa50d

File tree

3 files changed

+36
-1
lines changed

3 files changed

+36
-1
lines changed

.readthedocs.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the OS, Python version and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.10"
13+
# You can also specify other tool versions:
14+
# nodejs: "19"
15+
# rust: "1.64"
16+
# golang: "1.19"
17+
18+
# Build documentation in the "docs/" directory with Sphinx
19+
sphinx:
20+
configuration: docs/source/conf.py
21+
22+
# Optionally build your docs in additional formats such as PDF and ePub
23+
formats:
24+
- pdf
25+
# - epub
26+
27+
# Optional but recommended, declare the Python requirements required
28+
# to build your documentation
29+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
30+
python:
31+
install:
32+
- requirements: docs/requirements.txt

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
alabaster>=0.7.12
22
Sphinx>=1.7
33
sphinx-rtd-theme
4+
numpydoc
5+
pydata-sphinx-theme

docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@
8888
# a list of builtin themes.
8989
#
9090
# html_theme = "alabaster"
91-
html_theme = "sphinx_rtd_theme"
91+
# html_theme = "sphinx_rtd_theme"
92+
html_theme = "pydata_sphinx_theme"
9293

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

0 commit comments

Comments
 (0)