Skip to content

Commit

Permalink
DOC: show source link instead of download button
Browse files Browse the repository at this point in the history
* MAINT: clean up `conf.py` and remove `_templates`
  • Loading branch information
redeboer committed Jan 11, 2024
1 parent ba44dd5 commit d69d2ee
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 141 deletions.
2 changes: 0 additions & 2 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
],
"ignorePaths": [
"**/*.bib",
"**/*.rst_t",
"**/.cspell.json",
".constraints/*.txt",
".editorconfig",
Expand All @@ -33,7 +32,6 @@
".vscode/*",
"CITATION.cff",
"codecov.yml",
"docs/_templates/*",
"docs/conf.py",
"pyproject.toml",
"tox.ini",
Expand Down
55 changes: 0 additions & 55 deletions docs/_templates/genindex.html

This file was deleted.

4 changes: 0 additions & 4 deletions docs/_templates/layout.html

This file was deleted.

12 changes: 0 additions & 12 deletions docs/_templates/module.rst_t

This file was deleted.

49 changes: 0 additions & 49 deletions docs/_templates/package.rst_t

This file was deleted.

7 changes: 0 additions & 7 deletions docs/_templates/toc.rst_t

This file was deleted.

22 changes: 10 additions & 12 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,6 @@
]
generate_apidoc_package_path = f"../src/{PACKAGE}"
graphviz_output_format = "svg"
html_copy_source = True # needed for download notebook button
html_css_files = ["custom.css"]
html_favicon = "_static/favicon.ico"
html_last_updated_fmt = "%-d %B %Y"
Expand All @@ -166,7 +165,6 @@
html_show_sourcelink = False
html_show_sphinx = False
html_sourcelink_suffix = ""
html_static_path = ["_static"]
html_theme = "sphinx_book_theme"
html_theme_options = {
"icon_links": [
Expand Down Expand Up @@ -205,14 +203,6 @@
"type": "url",
},
],
"logo": {"text": REPO_TITLE},
"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",
Expand All @@ -221,8 +211,17 @@
"thebe": True,
"thebelab": True,
},
"logo": {"text": REPO_TITLE},
"path_to_docs": "docs",
"repository_branch": BRANCH,
"repository_url": f"https://github.com/{ORGANIZATION}/{REPO_NAME}",
"show_navbar_depth": 2,
"show_toc_level": 2,
"use_download_button": False,
"use_edit_page_button": True,
"use_issues_button": True,
"use_repository_button": True,
"use_source_button": True,
}
html_title = REPO_TITLE
intersphinx_mapping = {
Expand Down Expand Up @@ -253,8 +252,6 @@
"https://suchung.web.cern.ch",
"https://www.bookfinder.com",
]
master_doc = "index"
modindex_common_prefix = [f"{PACKAGE}."]
myst_enable_extensions = [
"amsmath",
"colon_fence",
Expand All @@ -275,6 +272,7 @@
""",
}
myst_update_mathjax = False
nb_execution_allow_errors = False
nb_execution_mode = get_execution_mode()
nb_execution_show_tb = True
nb_execution_timeout = -1
Expand Down

0 comments on commit d69d2ee

Please sign in to comment.