Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create separate API doc pages per module #765

Merged
merged 1 commit into from
Jul 18, 2020
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
7 changes: 7 additions & 0 deletions docs/api/miio.airconditioningcompanion.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airconditioningcompanion module
====================================

.. automodule:: miio.airconditioningcompanion
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.airdehumidifier.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airdehumidifier module
===========================

.. automodule:: miio.airdehumidifier
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.airfilter_util.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airfilter\_util module
===========================

.. automodule:: miio.airfilter_util
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.airfresh.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airfresh module
====================

.. automodule:: miio.airfresh
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.airfresh_t2017.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airfresh\_t2017 module
===========================

.. automodule:: miio.airfresh_t2017
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.airhumidifier.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airhumidifier module
=========================

.. automodule:: miio.airhumidifier
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.airhumidifier_jsq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airhumidifier\_jsq module
==============================

.. automodule:: miio.airhumidifier_jsq
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.airhumidifier_mjjsq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airhumidifier\_mjjsq module
================================

.. automodule:: miio.airhumidifier_mjjsq
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.airpurifier.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airpurifier module
=======================

.. automodule:: miio.airpurifier
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.airpurifier_miot.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airpurifier\_miot module
=============================

.. automodule:: miio.airpurifier_miot
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.airqualitymonitor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.airqualitymonitor module
=============================

.. automodule:: miio.airqualitymonitor
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.alarmclock.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.alarmclock module
======================

.. automodule:: miio.alarmclock
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.aqaracamera.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.aqaracamera module
=======================

.. automodule:: miio.aqaracamera
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.ceil.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.ceil module
================

.. automodule:: miio.ceil
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.ceil_cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.ceil\_cli module
=====================

.. automodule:: miio.ceil_cli
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.chuangmi_camera.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.chuangmi\_camera module
============================

.. automodule:: miio.chuangmi_camera
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.chuangmi_ir.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.chuangmi\_ir module
========================

.. automodule:: miio.chuangmi_ir
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.chuangmi_plug.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.chuangmi\_plug module
==========================

.. automodule:: miio.chuangmi_plug
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.cli module
===============

.. automodule:: miio.cli
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.click_common.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.click\_common module
=========================

.. automodule:: miio.click_common
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.cooker.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.cooker module
==================

.. automodule:: miio.cooker
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.device.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.device module
==================

.. automodule:: miio.device
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.discovery.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.discovery module
=====================

.. automodule:: miio.discovery
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.exceptions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.exceptions module
======================

.. automodule:: miio.exceptions
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.extract_tokens.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.extract\_tokens module
===========================

.. automodule:: miio.extract_tokens
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.fan.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.fan module
===============

.. automodule:: miio.fan
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.gateway.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.gateway module
===================

.. automodule:: miio.gateway
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.heater.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.heater module
==================

.. automodule:: miio.heater
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.miioprotocol.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.miioprotocol module
========================

.. automodule:: miio.miioprotocol
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.miot_device.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.miot\_device module
========================

.. automodule:: miio.miot_device
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.parse_ast.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.parse\_ast module
======================

.. automodule:: miio.parse_ast
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.philips_bulb.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.philips\_bulb module
=========================

.. automodule:: miio.philips_bulb
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.philips_eyecare.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.philips\_eyecare module
============================

.. automodule:: miio.philips_eyecare
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.philips_eyecare_cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.philips\_eyecare\_cli module
=================================

.. automodule:: miio.philips_eyecare_cli
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.philips_moonlight.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.philips\_moonlight module
==============================

.. automodule:: miio.philips_moonlight
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.philips_rwread.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.philips\_rwread module
===========================

.. automodule:: miio.philips_rwread
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.plug_cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.plug\_cli module
=====================

.. automodule:: miio.plug_cli
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.powerstrip.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.powerstrip module
======================

.. automodule:: miio.powerstrip
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.protocol.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.protocol module
====================

.. automodule:: miio.protocol
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.pwzn_relay.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.pwzn\_relay module
=======================

.. automodule:: miio.pwzn_relay
:members:
:undoc-members:
:show-inheritance:
68 changes: 68 additions & 0 deletions docs/api/miio.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
miio package
============

Submodules
----------

.. toctree::
:maxdepth: 4

miio.airconditioningcompanion
miio.airdehumidifier
miio.airfilter_util
miio.airfresh
miio.airfresh_t2017
miio.airhumidifier
miio.airhumidifier_jsq
miio.airhumidifier_mjjsq
miio.airpurifier
miio.airpurifier_miot
miio.airqualitymonitor
miio.alarmclock
miio.aqaracamera
miio.ceil
miio.ceil_cli
miio.chuangmi_camera
miio.chuangmi_ir
miio.chuangmi_plug
miio.cli
miio.click_common
miio.cooker
miio.device
miio.discovery
miio.exceptions
miio.extract_tokens
miio.fan
miio.gateway
miio.heater
miio.miioprotocol
miio.miot_device
miio.parse_ast
miio.philips_bulb
miio.philips_eyecare
miio.philips_eyecare_cli
miio.philips_moonlight
miio.philips_rwread
miio.plug_cli
miio.powerstrip
miio.protocol
miio.pwzn_relay
miio.toiletlid
miio.updater
miio.utils
miio.vacuum
miio.vacuum_cli
miio.vacuumcontainers
miio.viomivacuum
miio.waterpurifier
miio.wifirepeater
miio.wifispeaker
miio.yeelight

Module contents
---------------

.. automodule:: miio
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/api/miio.toiletlid.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
miio.toiletlid module
=====================

.. automodule:: miio.toiletlid
:members:
:undoc-members:
:show-inheritance:
Loading