Update apidocs for sphinx-generated documentation, which follows at l…

README.rst

@@ -0,0 +1,67 @@
+python-miio
+===========
+
+|PyPI version| |Build Status| |Code Health| |Coverage Status|
+
+This library (and its accompanying cli tool) is used to interface with devices using Xiaomi's `miIO protocol <https://github.com/OpenMiHome/mihome-binary-protocol/blob/master/doc/PROTOCOL.md>`__.
+
+.. NOTE::
+   The project has been recently renamed to `python-miio`.
+   Although the `mirobo` python package (as well as the console tool with the same name) are still available,
+   the users of the library are encouraged to start using the `miio` package.
+   The shipped console tools (and the API) are expected to stay backwards-compatible for the near future.
+
+
+Supported devices
+-----------------
+
+-  :doc:`Xiaomi Mi Robot Vacuum <vacuum>` (:class:`miio.vacuum`)
+-  Xiaomi Mi Air Purifier Pro & Air Purifier 2 (:class:`miio.airpurifier`)
+-  :doc:`Xiaomi Mi Smart WiFi Socket <plug>` (:class:`miio.plug`)
+-  :doc:`Xiaomi Mi Smart Socket Plug (1 Socket, 1 USB Port) <plug>` (:class:`miio.plug`)
+-  Xiaomi Smart Power Strip (WiFi, 6 Ports) (:class:`miio.powerstrip`)
+-  :doc:`Xiaomi Philips Eyecare Smart Lamp 2 <eyecare>` (:class:`miio.philips_eyecare`)
+-  :doc:`Xiaomi Philips LED Ceiling Lamp <ceil>` (:class:`miio.ceil`)
+-  Xiaomi Philips LED Ball Lamp (:class:`miio.philips_bulb`)
+-  Xiaomi Universal IR Remote Controller (Chuang Mi IR) (:class:`miio.chuangmi_ir`)
+-  Xiaomi Mi Smart Fan (:class:`miio.fan`)
+-  Xiaomi Mi Air Humidifier (:class:`miio.airhumidifier`)
+-  Xiaomi Mi Water Purifier (Basic support: Turn on & off) (:class:`miio.waterpurifier`)
+-  Xiaomi PM2.5 Air Quality Monitor (:class:`miio.airqualitymonitor`)
+-  Xiaomi Smart Wifi Speaker (:class:`miio.wifispeaker`) (incomplete, please `feel free to help improve the support <https://github.com/rytilahti/python-miio/issues/69>`__)
+-  Yeelight light bulbs (:class:`miio.yeelight`) (only a very rudimentary support, use `python-yeelight <https://gitlab.com/stavros/python-yeelight/>`__ for a more complete support)
+
+*Feel free to create a pull request to add support for new devices as
+well as additional features for supported devices.*
+
+
+Getting started
+---------------
+
+See the manual.
+
+.. TODO::
+   Add link to manual.
+
+
+Home Assistant support
+----------------------
+
+-  `Xiaomi Mi Robot
+   Vacuum <https://home-assistant.io/components/vacuum.xiaomi_miio/>`__
+-  `Xiaomi Philips
+   Light <https://home-assistant.io/components/light.xiaomi_miio/>`__
+-  `Xiaomi Mi Air
+   Purifier <https://github.com/syssi/xiaomi_airpurifier>`__
+-  `Xiaomi WiFi Plug <https://github.com/syssi/xiaomiplug>`__
+-  `Xiaomi Universal IR Remote
+   Controller <https://github.com/syssi/chuangmi_ir>`__
+
+.. |PyPI version| image:: https://badge.fury.io/py/python-miio.svg
+   :target: https://badge.fury.io/py/python-miio
+.. |Build Status| image:: https://travis-ci.org/rytilahti/python-miio.svg?branch=0.2.0
+   :target: https://travis-ci.org/rytilahti/python-miio
+.. |Code Health| image:: https://landscape.io/github/rytilahti/python-miio/master/landscape.svg?style=flat
+   :target: https://landscape.io/github/rytilahti/python-miio/master
+.. |Coverage Status| image:: https://coveralls.io/repos/github/rytilahti/python-miio/badge.svg?branch=master
+   :target: https://coveralls.io/github/rytilahti/python-miio?branch=master

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = python-miio
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/ceil.rst

@@ -0,0 +1,18 @@
+Ceil
+====
+
+.. todo::
+    Pull requests for documentation are welcome!
+
+
+See :ref:`miceil --help <miceil_help>` for usage.
+
+.. _miceil_help:
+
+
+`miceil --help`
+~~~~~~~~~~~~~~~
+
+.. click:: miio.ceil_cli:cli
+   :prog: miceil
+   :show-nested:

docs/conf.py

@@ -0,0 +1,179 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# python-miio documentation build configuration file, created by
+# sphinx-quickstart on Wed Oct 18 03:50:00 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx_autodoc_typehints',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.intersphinx',
+    'sphinx_click.ext']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'python-miio'
+copyright = '2017, Teemu Rytilahti'
+author = 'Teemu Rytilahti'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# 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
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'python-miiodoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'python-miio.tex', 'python-miio Documentation',
+     'Teemu Rytilahti', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'python-miio', 'python-miio Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'python-miio', 'python-miio Documentation',
+     author, 'python-miio', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+intersphinx_mapping = {'python': ('https://docs.python.org/3.6', None)}
+