Skip to content

Commit

Permalink
Merge pull request #1021 from xylar/fix-sphinx-multiversion
Browse files Browse the repository at this point in the history
Update sphinx-multiversion config options
  • Loading branch information
xylar authored Oct 18, 2024
2 parents 2a12199 + 325d7c9 commit 04abf48
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,14 +113,7 @@
# a list of builtin themes.
#

# on_rtd is whether we are on readthedocs.org, this line of code grabbed from
# docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down Expand Up @@ -225,3 +218,9 @@
outFile.write(output)

github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/'

# -- Options sphinx-multiversion -------------------------------------------
# Include tags like "tags/1.0.0" -- 1.7.2 doesn't build
smv_tag_whitelist = r'^(?!1.7.2)\d+\.\d+.\d+$'
smv_branch_whitelist = r'^(develop|main)$'
smv_remote_whitelist = 'origin'

0 comments on commit 04abf48

Please sign in to comment.