docs: some tweaks to sphinx docs

openfoodfacts · Jul 16, 2024 · 38c25ac · 38c25ac
1 parent ddebc60
commit 38c25ac
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
@@ -30,6 +30,14 @@
 
 html_theme = "alabaster"
 html_static_path = ["_static"]
+html_theme_options = {
+    "github_user": "openfoodfacts",
+    "github_repo": "search-a-licious",
+    "github_banner": True,
+    "extra_nav_links": {
+        "Back to main doc": "/search-a-licious",
+    },
+}
 
 # -- Options for autodoc pydantic --------------------------------------------
 autodoc_pydantic_model_show_json = True

diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst
@@ -8,6 +8,12 @@ Search-a-licious code documentation
 
 This documents the backend code of search-alicious.
 
+For `general documentation about search-a-licious Follow this link`__
+
+.. note: this only work on github pages
+.. __: /search-a-licious
+
+
 Contents:
 
 .. toctree::