From 954cf8065d8c1753b0385ad811f29f547919f47d Mon Sep 17 00:00:00 2001 From: RaulPPealez Date: Thu, 29 Feb 2024 15:00:56 +0100 Subject: [PATCH] Change sef43 references to openmm --- doc/_static/versions.json | 2 +- doc/conf.py | 54 ++++++++++++++++++--------------------- 2 files changed, 26 insertions(+), 30 deletions(-) diff --git a/doc/_static/versions.json b/doc/_static/versions.json index f751e76..889c4d1 100644 --- a/doc/_static/versions.json +++ b/doc/_static/versions.json @@ -1,6 +1,6 @@ [ { "version": "dev", - "url": "https://sef43.github.io/openmm-ml/dev/" + "url": "https://openmm.github.io/openmm-ml/dev/" } ] diff --git a/doc/conf.py b/doc/conf.py index f3ca868..abad3df 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -7,8 +7,7 @@ import git -sys.path.append(os.path.abspath('../')) - +sys.path.append(os.path.abspath("../")) # version specified in ../setup.py @@ -21,20 +20,19 @@ tag = next((tag for tag in repo.tags if tag.commit == repo.head.commit), None) if tag is None: - release = version + 'dev_' + short_sha - version_match = 'dev' + release = version + "dev_" + short_sha + version_match = "dev" version = version_match else: - release = str(tag) + '_' + short_sha + release = str(tag) + "_" + short_sha version_match = str(tag) version = version_match -print('version:', version) -print('git tag:', tag) -print('git sha:', short_sha) -print('release:', release) -print('version_match', version_match) - +print("version:", version) +print("git tag:", tag) +print("git sha:", short_sha) +print("release:", release) +print("version_match", version_match) extensions = [ @@ -43,7 +41,7 @@ "sphinx.ext.autosummary", "sphinx.ext.autodoc", "sphinx.ext.napoleon", - 'm2r2' + "m2r2", ] autosummary_generate = True @@ -56,8 +54,8 @@ source_suffix = ".rst" master_doc = "index" -project = u"OpenMM ML" -copyright = u"2023, Stanford University and the Authors" +project = "OpenMM ML" +copyright = "2023, Stanford University and the Authors" exclude_patterns = ["_build", "_templates"] @@ -74,27 +72,25 @@ "image_light": "_static/logo.png", "image_dark": "_static/logo.png", }, - "external_links": [ - {"name": "OpenMM.org", "url": "https://openmm.org/"}, - {"name": "OpenMM docs", "url": "https://openmm.org/documentation"}, - {"name": "GitHub", "url": "https://github.com/openmm"} + {"name": "OpenMM.org", "url": "https://openmm.org/"}, + {"name": "OpenMM docs", "url": "https://openmm.org/documentation"}, + {"name": "GitHub", "url": "https://github.com/openmm"}, ], - - "github_url": "https://github.com/openmm/openmm-ml" + "github_url": "https://github.com/openmm/openmm-ml", } # settings for version switcher and warning -html_theme_options["navbar_start"]=["navbar-logo", "version-switcher"] -html_theme_options["switcher"]= { - "json_url": "https://sef43.github.io/openmm-ml/dev/_static/versions.json", - "version_match": version_match, - } - -#https://github.com/pydata/pydata-sphinx-theme/issues/1552 -html_theme_options["show_version_warning_banner"]=False -html_theme_options["check_switcher"]=False +html_theme_options["navbar_start"] = ["navbar-logo", "version-switcher"] +html_theme_options["switcher"] = { + "json_url": "https://openmm.github.io/openmm-ml/dev/_static/versions.json", + "version_match": version_match, +} + +# https://github.com/pydata/pydata-sphinx-theme/issues/1552 +html_theme_options["show_version_warning_banner"] = False +html_theme_options["check_switcher"] = False # Napoleon settings napoleon_google_docstring = True