bugfix

SpeysideHEP · Jan 9, 2024 · fe010cc · fe010cc
1 parent 5e31352
commit fe010cc
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -47,7 +47,7 @@
 ]
 
 # set the width of the page
-sphinx_rtd_size_width = "100%"
+# sphinx_rtd_size_width = "100%"
 
 # external links
 xref_links = {
@@ -95,10 +95,39 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_book_theme"
+
+html_theme_options = {
+    "repository_provider": "github",
+    "repository_url": "https://github.com/SpeysideHEP/spey",
+    "use_repository_button": True,  # add a 'link to repository' button
+    "use_issues_button": False,  # add an 'Open an Issue' button
+    "path_to_docs": "docs",
+    "use_edit_page_button": True,
+    "use_fullscreen_button": True,
+    # "launch_buttons": {
+    #     "colab_url": "https://colab.research.google.com/",
+    # },
+    "show_navbar_depth": 1,
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/SpeysideHEP/spey",
+            "icon": "fa-brands fa-github",
+        },
+        {
+            "name": "arXiv",
+            "url": "https://arxiv.org/abs/2307.06996",
+            "icon": "https://img.shields.io/static/v1?style=plastic&label=arXiv&message=2307.06996&color=brightgreen",
+            "type": "url",
+        },
+    ],
+}
+
 html_static_path = ["_static"]
 html_css_files = ["css/custom.css"]
 
 html_logo = "img/logo.png"
+html_favicon = "img/logo.png"
 logo_only = True
 
 # Output file base name for HTML help builder.
@@ -109,6 +138,7 @@
 copybutton_prompt_is_regexp = True
 copybutton_here_doc_delimiter = "EOF"
 
+
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,9 +6,6 @@
 Welcome to the documentation of Spey
 ====================================
 
-.. image:: https://img.shields.io/static/v1?style=plastic&label=arXiv&message=2307.06996&color=brightgreen
-    :target: https://arxiv.org/abs/2307.06996
-
 .. image:: https://img.shields.io/static/v1?style=plastic&label&message=GitHub&logo=github&logoColor=black&color=white
     :target: https://github.com/SpeysideHEP/spey
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -8,3 +8,4 @@ sphinx-copybutton>=0.3.2
 sphinx-togglebutton>=0.3.0
 myst-parser
 sphinx-rtd-size
+sphinx-book-theme