Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
39 changes: 30 additions & 9 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <autoapi/autointent/index>`
...............................................

lotta stuff
Loading