Skip to content

Commit

Permalink
Change sef43 references to openmm
Browse files Browse the repository at this point in the history
  • Loading branch information
RaulPPelaez committed Feb 29, 2024
1 parent c588a99 commit 954cf80
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 30 deletions.
2 changes: 1 addition & 1 deletion doc/_static/versions.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[
{
"version": "dev",
"url": "https://sef43.github.io/openmm-ml/dev/"
"url": "https://openmm.github.io/openmm-ml/dev/"
}
]
54 changes: 25 additions & 29 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
import git


sys.path.append(os.path.abspath('../'))

sys.path.append(os.path.abspath("../"))


# version specified in ../setup.py
Expand All @@ -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 = [
Expand All @@ -43,7 +41,7 @@
"sphinx.ext.autosummary",
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
'm2r2'
"m2r2",
]

autosummary_generate = True
Expand All @@ -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"]
Expand All @@ -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
Expand Down

0 comments on commit 954cf80

Please sign in to comment.