Skip to content

Commit

Permalink
Merge pull request #107 from broadinstitute/docs
Browse files Browse the repository at this point in the history
more ReadTheDocs fixes
  • Loading branch information
dpark01 committed Aug 1, 2024
2 parents d9327c8 + ef2eae6 commit d3e988a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
7 changes: 6 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
# Required
version: 2

# Set the version of Python
build:
os: ubuntu-22.04
tools:
python: "3.10"

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
Expand All @@ -19,6 +25,5 @@ formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.10
install:
- requirements: docs/requirements.txt
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def _git_version():
# 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.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.imgmath', 'sphinxarg.ext',]
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.imgmath', 'sphinxarg.ext', 'sphinx_rtd_theme']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down Expand Up @@ -122,7 +122,7 @@ def _git_version():
# a list of builtin themes.
on_rtd = os.environ.get('READTHEDOCS') == 'True'
if on_rtd:
html_theme = 'default'
html_theme = 'sphinx_rtd_theme'
else:
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
Expand Down

0 comments on commit d3e988a

Please sign in to comment.