Skip to content

Commit

Permalink
Improve documentation presentation (#777)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
rytilahti committed Jul 28, 2020
1 parent ab99f5d commit d823e22
Show file tree
Hide file tree
Showing 4 changed files with 134 additions and 111 deletions.
1 change: 1 addition & 0 deletions docs/api/miio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Submodules
miio.airfresh_t2017
miio.airhumidifier
miio.airhumidifier_jsq
miio.airhumidifier_miot
miio.airhumidifier_mjjsq
miio.airpurifier
miio.airpurifier_miot
Expand Down
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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}
Loading

0 comments on commit d823e22

Please sign in to comment.