Skip to content

Commit

Permalink
Merge pull request #136 from decarlof/master
Browse files Browse the repository at this point in the history
rtd required update
  • Loading branch information
decarlof committed Aug 22, 2023
2 parents 84870d4 + f8a2c32 commit 5fa9e12
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
15 changes: 15 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
sphinx:
configuration: docs/conf.py
python:
install:
- requirements: envs/requirements-doc.txt
submodules:
recursive: false
build:
os: ubuntu-22.04
tools:
python: "3"
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
import sys
import os

import sphinx_rtd_theme

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand Down Expand Up @@ -130,7 +132,8 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
Expand Down
6 changes: 4 additions & 2 deletions envs/requirements-doc.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
sphinx
sphinxcontrib-bibtex
sphinx >=5, <6
sphinx_rtd_theme >=1, <2
sphinxcontrib-bibtex >=2, <3
nbsphinx

0 comments on commit 5fa9e12

Please sign in to comment.