Skip to content

Commit

Permalink
DOC: switch to source code link button (#210)
Browse files Browse the repository at this point in the history
* MAINT: remove docstring from `conf.py`
* MAINT: remove redundant `master_doc` and `source_suffix`
* MAINT: sort `html_theme_options`
  • Loading branch information
redeboer authored Jan 20, 2024
1 parent bc06463 commit c09fcb3
Showing 1 changed file with 8 additions and 19 deletions.
27 changes: 8 additions & 19 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
"""Configuration file for the Sphinx documentation builder.
This file only contains a selection of the most common options. For a full list see the
documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html
"""

from __future__ import annotations

from datetime import datetime
Expand Down Expand Up @@ -103,20 +97,21 @@
html_static_path = ["_static"]
html_theme = "sphinx_book_theme"
html_theme_options = {
"repository_url": f"https://github.com/{ORGANIZATION}/{REPO_NAME}",
"repository_branch": BRANCH,
"path_to_docs": "docs",
"use_download_button": True,
"use_edit_page_button": True,
"use_issues_button": True,
"use_repository_button": True,
"launch_buttons": {
"binderhub_url": "https://mybinder.org",
"colab_url": "https://colab.research.google.com",
"notebook_interface": "jupyterlab",
"thebe": True,
"thebelab": True,
},
"path_to_docs": "docs",
"repository_branch": BRANCH,
"repository_url": f"https://github.com/{ORGANIZATION}/{REPO_NAME}",
"use_download_button": False,
"use_edit_page_button": True,
"use_issues_button": True,
"use_repository_button": True,
"use_source_button": True,
}
html_title = "Partial Wave Analysis"
intersphinx_mapping = {
Expand All @@ -137,7 +132,6 @@
"https://suchung.web.cern.ch",
"https://www.bookfinder.com",
]
master_doc = "index"
modindex_common_prefix = [f"{PACKAGE}."]
myst_enable_extensions = [
"amsmath",
Expand Down Expand Up @@ -167,11 +161,6 @@
project = REPO_TITLE
pygments_style = "sphinx"
release = get_package_version(PACKAGE)
source_suffix = {
".ipynb": "myst-nb",
".md": "myst-nb",
".rst": "restructuredtext",
}
thebe_config = {
"repository_url": html_theme_options["repository_url"],
"repository_branch": html_theme_options["repository_branch"],
Expand Down

0 comments on commit c09fcb3

Please sign in to comment.