Reference to github (#19)

* reference to github Signed-off-by: Christian Henkel <[email protected]> * Less deep content on root page Signed-off-by: Christian Henkel <[email protected]> --------- Signed-off-by: Christian Henkel <[email protected]>
boschresearch · Aug 13, 2024 · 030fcf0 · 030fcf0
1 parent c4b3c8f
commit 030fcf0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,10 +24,15 @@
 }
 html_logo = 'logo.png'
 html_extra_path = ['../../']
+html_context = {
+    "display_github": True,
+    "github_user": "boschresearch",
+    "github_repo": "bt_tools",
+    "github_version": "main",
+    "conf_py_path": "docs/source/",
+}
 
-# -- Options for EPUB output
-epub_show_urls = 'footnote'
-
+# -- autodoc config
 autodoc2_packages = [
     "../../btlib/src/btlib",
     "../../bt_view/src/bt_view",

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,6 +4,7 @@ Contents
 --------
 
 .. toctree::
+   :maxdepth: 1
 
    tutorials
    apidocs/index