Docs/theme settings

docs/source/conf.py

@@ -68,8 +68,29 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "pydata_sphinx_theme"
-html_static_path = ["_static"]
-nbsphinx_execute = "always"
+html_static_path = ["../_static"]
+
+html_theme_options = {
+    "logo": {
+        "text": "AutoIntent",
+        "image_light": "../_static/logo-light.svg",
+        "image_dark": "../_static/logo-dark.svg",
+    },
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/deeppavlov/AutoIntent",
+            "icon": "fa-brands fa-github",
+            "type": "fontawesome",
+        },
+    ],
+    "show_toc_level": 3,
+}
+
+html_favicon = "../_static/logo-white.svg"
+html_show_sourcelink = False
+
+toc_object_entries_show_parents = "hide"
 
 todo_include_todos = True
 
@@ -87,6 +108,7 @@
 nbsphinx_prolog = """
 :tutorial_name: {{ env.docname }}
 """
+nbsphinx_execute = "always"
 
 mathjax_path = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
 

docs/source/index.rst

@@ -26,28 +26,28 @@ Example of building an intent classifier in a couple of lines of code:
 Documentation Contents
 ----------------------
 
-:doc:`quickstart`
-.................
+:doc:`Quickstart <quickstart>`
+..............................
 
 It is recommended to begin with the :doc:`quickstart` page. It contains overview of our capabilities.
 
-:doc:`concepts`
-...............
+:doc:`Key Concepts <concepts>`
+..............................
 
 This page contains basic information about the terms and concepts we use throughout our documentation.
 
-:doc:`tutorials`
-................
+:doc:`Tutorials <tutorials>`
+............................
 
 Newbie-friendly information on how to perform different tasks using our library.
 
-:doc:`guides/index`
-...................
+:doc:`User Guides<guides/index>`
+................................
 
 Some advanced information
 
-:doc:`learn/index`
-..................
+:doc:`Learn AutoIntent<learn/index>`
+....................................
 
 Some theoretical background
 

docs/source/quickstart.rst

@@ -1,4 +1,4 @@
-Quick Start
+Quickstart
 ===========
 
 Installation

docs/source/tutorials.rst

@@ -4,5 +4,6 @@ Tutorials
 .. toctree::
    :name: tutorials
    :glob:
+   :maxdepth: 2
 
    tutorials/index_*