Skip to content

Commit

Permalink
updated sphinx config
Browse files Browse the repository at this point in the history
  • Loading branch information
bobmyhill committed Nov 14, 2024
1 parent 9ae4259 commit b05da14
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@
import os
import sys

# Define the canonical URL if you are using 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


sys.path.insert(0, os.path.abspath(".."))
sys.path.insert(0, os.path.abspath("../examples"))
sys.path.insert(0, os.path.abspath("../tutorial"))
Expand All @@ -33,8 +43,8 @@
author = "Robert Myhill, Sanne Cottaar, Timo Heister, Ian Rose, Cayman Unterborn"

# The short X.Y version.
v = burnman.__version__.split('.')
version = f'{v[0]}.{v[1]}'
v = burnman.__version__.split(".")
version = f"{v[0]}.{v[1]}"
# The full version, including alpha/beta/rc tags
release = burnman.__version__

Expand Down Expand Up @@ -307,4 +317,4 @@
# texinfo_show_urls = 'footnote'

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"http://docs.python.org/": None}
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

0 comments on commit b05da14

Please sign in to comment.