Skip to content

Commit

Permalink
Fix ReadTheDocs 'latest' build (erf-model#1292)
Browse files Browse the repository at this point in the history
* Explicitly set html_theme_path

* Add sphinx_rtd_theme extension

* Add requirements.txt

* Cleanup
  • Loading branch information
ewquon authored Nov 13, 2023
1 parent 52c09fd commit 4fd58be
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
6 changes: 5 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@ build:
tools:
python: "3.11"

python:
install:
- requirements: Docs/sphinx_doc/requirements.txt

sphinx:
configuration: Docs/sphinx_doc/conf.py

formats:
- htmlzip
# - pdf
# - epub
# - epub
8 changes: 6 additions & 2 deletions Docs/sphinx_doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [ 'sphinx.ext.mathjax']
extensions = [
'sphinx.ext.mathjax',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down Expand Up @@ -134,7 +136,9 @@
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# Add path to the RTD explicitly to robustify builds
import sphinx_rtd_theme
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
Expand Down
1 change: 1 addition & 0 deletions Docs/sphinx_doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx-rtd-theme>=1.0.0

0 comments on commit 4fd58be

Please sign in to comment.