Skip to content

Commit

Permalink
update sphinx configuration for read the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rebeccabilbro committed Sep 27, 2024
1 parent f7a8e95 commit 90ac815
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
11 changes: 10 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down Expand Up @@ -191,6 +191,15 @@
## Options for HTML output
##########################################################################

# Define the canonical URL for a custom domain on Read the Docs
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")

# Tell Jinja2 templates the build is running on Read the Docs
if os.environ.get("READTHEDOCS", "") == "True":
if "html_context" not in globals():
html_context = {}
html_context["READTHEDOCS"] = True

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
Expand Down
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cycler>=0.10.0
umap-learn>=0.5.1

# Documentation Dependencies
Sphinx>=3.4
sphinx-rtd-theme>=0.5.1
Sphinx==8.0.2
sphinx-rtd-theme==3.0.0rc1
numpydoc>=1.1
pandas>=1.0.4

0 comments on commit 90ac815

Please sign in to comment.