From c87a405887bc29627726fa7b70d894df2debfdbd Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 23:44:51 +0100 Subject: [PATCH 1/4] MAINT: remove docstring from `conf.py` --- docs/conf.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 3f4380df..6e89f730 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 import os From 01fc09469f0cd06ba7da51b8632c2df837e7d631 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 23:45:34 +0100 Subject: [PATCH 2/4] MAINT: remove redundant `master_doc` and `source_suffix` --- docs/conf.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 6e89f730..47bf8633 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -216,7 +216,6 @@ def get_tensorflow_url() -> str: linkcheck_ignore = [ "https://unix.stackexchange.com/a/129144", ] -master_doc = "index" modindex_common_prefix = [f"{PACKAGE}."] myst_enable_extensions = [ "amsmath", @@ -251,11 +250,6 @@ def get_tensorflow_url() -> str: project = REPO_TITLE pygments_style = "sphinx" release = get_package_version("tensorwaves") -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"], From c586f729c5565b22c705f3970c0857f814446639 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 23:46:28 +0100 Subject: [PATCH 3/4] MAINT: sort `html_theme_options` --- docs/conf.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 47bf8633..cdd3acce 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -173,14 +173,6 @@ def get_tensorflow_url() -> str: "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", @@ -189,8 +181,16 @@ def get_tensorflow_url() -> str: "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": True, + "use_edit_page_button": True, + "use_issues_button": True, + "use_repository_button": True, } html_title = REPO_TITLE intersphinx_mapping = { From 10a176cb7ec42bde51cb1b08c8a2342f32ec2f47 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 23:47:11 +0100 Subject: [PATCH 4/4] DOC: switch to source code button --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index cdd3acce..50cf8789 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -187,10 +187,11 @@ def get_tensorflow_url() -> str: "repository_url": f"https://github.com/{ORGANIZATION}/{REPO_NAME}", "show_navbar_depth": 2, "show_toc_level": 2, - "use_download_button": True, + "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 = {