Skip to content

Commit 658073e

Browse files
authored
Docs/change appearance (#65)
* own page for each class and function & pydata theme * try notebook execution
1 parent 55191d5 commit 658073e

File tree

2 files changed

+35
-10
lines changed

2 files changed

+35
-10
lines changed

docs/source/conf.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,16 @@
6060
"imported-members",
6161
]
6262
autodoc_typehints = "description"
63+
autoapi_own_page_level = "function"
64+
suppress_warnings = ["autoapi.python_import_resolution"]
65+
autoapi_add_toctree_entry = False
6366

6467
# -- Options for HTML output -------------------------------------------------
6568
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
6669

67-
html_theme = "alabaster"
70+
html_theme = "pydata_sphinx_theme"
6871
html_static_path = ["_static"]
72+
nbsphinx_execute = "always"
6973

7074
todo_include_todos = True
7175

docs/source/index.rst

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,35 @@ Example of building an intent classifier in a couple of lines of code:
2323
pipeline.fit(dataset)
2424
pipeline.predict(["Hello, World!"])
2525
26-
We recommend you to begin your exploration of our library from the :doc:`quickstart` page.
26+
Documentation Contents
27+
----------------------
2728

28-
.. toctree::
29-
:maxdepth: 1
30-
:caption: Contents:
29+
:doc:`quickstart`
30+
.................
3131

32-
quickstart
33-
concepts
34-
tutorials
35-
guides/index
36-
learn/index
32+
It is recommended to begin with the :doc:`quickstart` page. It contains overview of our capabilities.
33+
34+
:doc:`concepts`
35+
...............
36+
37+
This page contains basic information about the terms and concepts we use throughout our documentation.
38+
39+
:doc:`tutorials`
40+
................
41+
42+
Newbie-friendly information on how to perform different tasks using our library.
43+
44+
:doc:`guides/index`
45+
...................
46+
47+
Some advanced information
48+
49+
:doc:`learn/index`
50+
..................
51+
52+
Some theoretical background
53+
54+
:doc:`API Reference <autoapi/autointent/index>`
55+
...............................................
56+
57+
lotta stuff

0 commit comments

Comments
 (0)