diff --git a/docs/source/conf.py b/docs/source/conf.py index 579e2a637..edfb3c9ad 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -60,12 +60,16 @@ "imported-members", ] autodoc_typehints = "description" +autoapi_own_page_level = "function" +suppress_warnings = ["autoapi.python_import_resolution"] +autoapi_add_toctree_entry = False # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "alabaster" +html_theme = "pydata_sphinx_theme" html_static_path = ["_static"] +nbsphinx_execute = "always" todo_include_todos = True diff --git a/docs/source/index.rst b/docs/source/index.rst index c41e2cac7..48f8a0957 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,14 +23,35 @@ Example of building an intent classifier in a couple of lines of code: pipeline.fit(dataset) pipeline.predict(["Hello, World!"]) -We recommend you to begin your exploration of our library from the :doc:`quickstart` page. +Documentation Contents +---------------------- -.. toctree:: - :maxdepth: 1 - :caption: Contents: +:doc:`quickstart` +................. - quickstart - concepts - tutorials - guides/index - learn/index +It is recommended to begin with the :doc:`quickstart` page. It contains overview of our capabilities. + +:doc:`concepts` +............... + +This page contains basic information about the terms and concepts we use throughout our documentation. + +:doc:`tutorials` +................ + +Newbie-friendly information on how to perform different tasks using our library. + +:doc:`guides/index` +................... + +Some advanced information + +:doc:`learn/index` +.................. + +Some theoretical background + +:doc:`API Reference ` +............................................... + +lotta stuff