Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
tristan-salles committed Jun 20, 2024
1 parent cd28397 commit 268e551
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 18 deletions.
13 changes: 0 additions & 13 deletions docs/_static/version_switcher.json

This file was deleted.

27 changes: 22 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,22 @@
# },
}

if 'dev' in version:
html_theme_options["switcher"]["version_match"] = "development"
html_theme_options["show_version_warning_banner"] = False

if 'versionwarning' in tags: # noqa: F821
# Specific to docs.scipy.org deployment.
# See https://github.com/scipy/docs.scipy.org/blob/main/_static/versionwarning.js_t
src = ('var script = document.createElement("script");\n'
'script.type = "text/javascript";\n'
'script.src = "/doc/_static/versionwarning.js";\n'
'document.head.appendChild(script);')
html_context = {
'VERSIONCHECK_JS': src
}
html_js_files = ['versioncheck.js']

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand All @@ -181,10 +197,11 @@
"try_examples.css",
]

# html_css_files = [
# "css/getting_started.css",
# "css/gospl.css",
# ]
html_additional_pages = {}
html_use_modindex = True
html_domain_indices = False
html_copy_source = False
html_file_suffix = '.html'

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
Expand Down Expand Up @@ -216,7 +233,7 @@
# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "gospldoc"
htmlhelp_basename = "gospl"


# -- Options for LaTeX output ------------------------------------------------
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ myst_nb
numpydoc
sphinx_design
jupyterlite_sphinx
intersphinx_registry

0 comments on commit 268e551

Please sign in to comment.