Improve documentation presentation (#777)

* Improve documentation presentation * Use rtd theme, which is much more readable than alabaster * Show inherited members from the base classes * Order elements by type instead by alphabetical order * update poetry.lock to include the theme * decomment the groupwise ordering
rytilahti · Jul 28, 2020 · d823e22 · d823e22
1 parent ab99f5d
commit d823e22
Show file tree

Hide file tree

Showing 4 changed files with 134 additions and 111 deletions.
diff --git a/docs/api/miio.rst b/docs/api/miio.rst
@@ -14,6 +14,7 @@ Submodules
    miio.airfresh_t2017
    miio.airhumidifier
    miio.airhumidifier_jsq
+   miio.airhumidifier_miot
    miio.airhumidifier_mjjsq
    miio.airpurifier
    miio.airpurifier_miot

diff --git a/docs/conf.py b/docs/conf.py
@@ -92,7 +92,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -188,3 +188,6 @@
 apidoc_output_dir = "api"
 apidoc_excluded_paths = ["tests"]
 apidoc_separate_modules = True
+autodoc_member_order = "groupwise"
+autodoc_inherit_docstrings = True
+autodoc_default_options = {"inherited-members": True}