Skip to content

Commit 6762900

Browse files
authored
Merge branch 'dev' into docs/fix-links
2 parents 0f15476 + f0b7885 commit 6762900

File tree

7 files changed

+74
-13
lines changed

7 files changed

+74
-13
lines changed

docs/_static/logo-dark.svg

Lines changed: 7 additions & 0 deletions
Loading

docs/_static/logo-light.svg

Lines changed: 7 additions & 0 deletions
Loading

docs/_static/logo-white.svg

Lines changed: 24 additions & 0 deletions
Loading

docs/source/conf.py

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,29 @@
7979
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
8080

8181
html_theme = "pydata_sphinx_theme"
82-
html_static_path = ["_static"]
83-
nbsphinx_execute = "never"
82+
html_static_path = ["../_static"]
83+
84+
html_theme_options = {
85+
"logo": {
86+
"text": "AutoIntent",
87+
"image_light": "../_static/logo-light.svg",
88+
"image_dark": "../_static/logo-dark.svg",
89+
},
90+
"icon_links": [
91+
{
92+
"name": "GitHub",
93+
"url": "https://github.com/deeppavlov/AutoIntent",
94+
"icon": "fa-brands fa-github",
95+
"type": "fontawesome",
96+
},
97+
],
98+
"show_toc_level": 3,
99+
}
100+
101+
html_favicon = "../_static/logo-white.svg"
102+
html_show_sourcelink = False
103+
104+
toc_object_entries_show_parents = "hide"
84105

85106
todo_include_todos = True
86107

@@ -98,6 +119,7 @@
98119
nbsphinx_prolog = """
99120
:tutorial_name: {{ env.docname }}
100121
"""
122+
nbsphinx_execute = "always"
101123

102124
mathjax_path = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
103125

docs/source/index.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,28 @@ Example of building an intent classifier in a couple of lines of code:
2626
Documentation Contents
2727
----------------------
2828

29-
:doc:`quickstart`
30-
.................
29+
:doc:`Quickstart <quickstart>`
30+
..............................
3131

3232
It is recommended to begin with the :doc:`quickstart` page. It contains overview of our capabilities.
3333

34-
:doc:`concepts`
35-
...............
34+
:doc:`Key Concepts <concepts>`
35+
..............................
3636

3737
This page contains basic information about the terms and concepts we use throughout our documentation.
3838

39-
:doc:`tutorials`
40-
................
39+
:doc:`Tutorials <tutorials>`
40+
............................
4141

4242
Newbie-friendly information on how to perform different tasks using our library.
4343

44-
:doc:`guides/index`
45-
...................
44+
:doc:`User Guides<guides/index>`
45+
................................
4646

4747
Some advanced information
4848

49-
:doc:`learn/index`
50-
..................
49+
:doc:`Learn AutoIntent<learn/index>`
50+
....................................
5151

5252
Some theoretical background
5353

docs/source/quickstart.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Quick Start
1+
Quickstart
22
===========
33

44
Installation

docs/source/tutorials.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@ Tutorials
44
.. toctree::
55
:name: tutorials
66
:glob:
7+
:maxdepth: 2
78

89
tutorials/index_*

0 commit comments

Comments
 (0)