From 32dd5be6674058885e364070b45706254a8eeacc Mon Sep 17 00:00:00 2001 From: Ben Dichter Date: Sun, 10 Mar 2024 17:48:38 -0400 Subject: [PATCH 1/3] docs: add html_theme_options Add edit button to docs and a link to the GitHub repo --- docs/conf.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 4e6207d17..3dc6d6c9a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -66,6 +66,18 @@ } add_module_names = False +html_theme_options = { + "use_edit_page_button": True, + "icon_links": [ + { + "name": "GitHub", + "url": "https://github.com/catalystneuro/neuroconv", + "icon": "fa-brands fa-github", + "type": "fontawesome", + }, + ], +} + def _correct_signatures(app, what, name, obj, options, signature, return_annotation): if what == "class": From 2fa6f1baa27d8012149781cc52085fed623e0394 Mon Sep 17 00:00:00 2001 From: Ben Dichter Date: Sun, 10 Mar 2024 17:51:00 -0400 Subject: [PATCH 2/3] Update docs/conf.py Co-authored-by: Cody Baker <51133164+CodyCBakerPhD@users.noreply.github.com> --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 3dc6d6c9a..9b9967010 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -71,7 +71,7 @@ "icon_links": [ { "name": "GitHub", - "url": "https://github.com/catalystneuro/neuroconv", + "url": "https://github.com/NeurodataWithoutBorders/nwb-guide", "icon": "fa-brands fa-github", "type": "fontawesome", }, From 52b825ba4bfbc43eed40a2dc182b50c3b7902d0b Mon Sep 17 00:00:00 2001 From: Ben Dichter Date: Sun, 10 Mar 2024 18:32:00 -0400 Subject: [PATCH 3/3] Update conf.py add html_context --- docs/conf.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 9b9967010..c2ab76e33 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -78,6 +78,14 @@ ], } +html_context = { + # "github_url": "https://github.com", # or your GitHub Enterprise site + "github_user": "NeurodataWithoutBorders", + "github_repo": "nwb-guide", + "github_version": "main", + "doc_path": "docs", +} + def _correct_signatures(app, what, name, obj, options, signature, return_annotation): if what == "class":