diff --git a/docs/_static/logo-dark.svg b/docs/_static/logo-dark.svg new file mode 100644 index 000000000..6edc6e66f --- /dev/null +++ b/docs/_static/logo-dark.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/_static/logo-light.svg b/docs/_static/logo-light.svg new file mode 100644 index 000000000..ca4a5641c --- /dev/null +++ b/docs/_static/logo-light.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/_static/logo-white.svg b/docs/_static/logo-white.svg new file mode 100644 index 000000000..80142dfde --- /dev/null +++ b/docs/_static/logo-white.svg @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/conf.py b/docs/source/conf.py index edfb3c9ad..1d9546752 100644 --- a/docs/source/conf.py +++ b/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" diff --git a/docs/source/index.rst b/docs/source/index.rst index 48f8a0957..8ba1174d2 100644 --- a/docs/source/index.rst +++ b/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 ` +.............................. It is recommended to begin with the :doc:`quickstart` page. It contains overview of our capabilities. -:doc:`concepts` -............... +:doc:`Key Concepts ` +.............................. This page contains basic information about the terms and concepts we use throughout our documentation. -:doc:`tutorials` -................ +:doc:`Tutorials ` +............................ Newbie-friendly information on how to perform different tasks using our library. -:doc:`guides/index` -................... +:doc:`User Guides` +................................ Some advanced information -:doc:`learn/index` -.................. +:doc:`Learn AutoIntent` +.................................... Some theoretical background diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index 9bc8ecbe2..381be9238 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -1,4 +1,4 @@ -Quick Start +Quickstart =========== Installation diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst index cb704e115..7652811c9 100644 --- a/docs/source/tutorials.rst +++ b/docs/source/tutorials.rst @@ -4,5 +4,6 @@ Tutorials .. toctree:: :name: tutorials :glob: + :maxdepth: 2 tutorials/index_*