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

rytilahti · 2017-10-19T20:17:01Z

…ater point. Includes also some slight clean-ups.

Note: marking this as WIP as the sphinx-generated doc part will follow at later point in time. For now this is here up for a review & to wait for fixing a couple of added FIXMEs.

The idea is to tidy up the README.md (and convert to .rst), and have a proper separated documentation.

houndci-bot · 2017-10-19T20:17:12Z

miio/vacuumcontainers.py

@@ -282,7 +309,15 @@ def __repr__(self) -> str:


 class ConsumableStatus:
-    """Container for consumable status information."""
+    """Container for consumable status information,
+    including information about brushes and duration until they should be changed.


line too long (82 > 79 characters)

houndci-bot · 2017-10-19T20:17:12Z

miio/vacuumcontainers.py

        return error_codes[self.data[4]]

    @property
    def complete(self) -> bool:
+        """Return True if the cleaning run was complete (e.g. without errors), see also :func:`error`."""


line too long (105 > 79 characters)

houndci-bot · 2017-10-19T20:17:12Z

miio/vacuumcontainers.py

        return int(self.data[2])

    @property
    def ids(self) -> List[int]:
+        """A list of available cleaning IDs, see also :class:`CleaningDetails`."""


line too long (82 > 79 characters)

houndci-bot · 2017-10-19T20:17:12Z

miio/vacuumcontainers.py

        return self.is_on
        # we are not using in_cleaning as it does not seem to work properly.
        # return bool(self.data["in_cleaning"])

    @property
    def is_on(self) -> bool:
-        """Return True if cleaning (automatic, manual or spot)."""
+        """True if device is currently cleaning (either automatic, manual or spot)."""


line too long (86 > 79 characters)

houndci-bot · 2017-10-19T20:17:12Z

miio/vacuumcontainers.py

        return bool(self.data["map_present"])

    @property
    @deprecated("See is_on")
    def in_cleaning(self) -> bool:
+        """True if currently cleaning. Please use :func:`is_on` instead of this."""


line too long (83 > 79 characters)

houndci-bot · 2017-10-19T20:17:12Z

miio/device.py

@@ -161,7 +190,14 @@ def discover(addr: str=None) -> Any:
                break

    def send(self, command: str, parameters: Any=None, retry_count=3) -> Any:
-        """Build and send the given command."""
+        """Build and send the given command.
+        Note that this will implicitly call :func:`do_discover` to do a handshake,


line too long (82 > 79 characters)

houndci-bot · 2017-10-19T20:17:12Z

miio/device.py

+    """Base class for all device implementations.
+    This is the main class providing the basic protocol handling for devices using
+    the ``miIO`` protocol.
+    This class should not be initialized directly but a device-specific class inheriting


line too long (88 > 79 characters)

houndci-bot · 2017-10-19T20:17:12Z

miio/device.py

        return self.data


 class Device:
-    """Base class for all device implementations."""
+    """Base class for all device implementations.
+    This is the main class providing the basic protocol handling for devices using


line too long (82 > 79 characters)

houndci-bot · 2017-10-19T20:17:12Z

miio/android_backup.py

        tar = self.read_tar(password)
        return tar.list()

    def pack(self, fname, password=None):
+        """Pack given directory `fname`, and encrypt with `password` if given."""


line too long (81 > 79 characters)

houndci-bot · 2017-10-19T20:17:12Z

miio/android_backup.py

    def __init__(self, fname=None):
+        """Initializes AndroidBackup.
+        If `fname` is given, the file will be opened for reading in binary mode.


line too long (80 > 79 characters)

houndci-bot · 2017-10-19T20:23:05Z

docs/conf.py

+]
+
+intersphinx_mapping = {'python': ('https://docs.python.org/3.6', None)}
+


blank line at end of file

houndci-bot · 2017-10-19T20:23:05Z

docs/conf.py

+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.intersphinx']


continuation line under-indented for visual indent

houndci-bot · 2017-10-19T20:23:05Z

docs/conf.py

+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',


continuation line under-indented for visual indent

houndci-bot · 2017-10-19T20:23:05Z

docs/conf.py

+    'sphinx_autodoc_typehints',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',


continuation line under-indented for visual indent

houndci-bot · 2017-10-19T20:23:05Z

docs/conf.py

+]
+
+intersphinx_mapping = {'python': ('https://docs.python.org/3.6', None)}
+


blank line at end of file

houndci-bot · 2017-10-19T20:23:06Z

docs/conf.py

+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.intersphinx']


continuation line under-indented for visual indent

houndci-bot · 2017-10-19T20:23:06Z

docs/conf.py

+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',


continuation line under-indented for visual indent

houndci-bot · 2017-10-19T20:23:06Z

docs/conf.py

+    'sphinx_autodoc_typehints',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',


continuation line under-indented for visual indent

coveralls · 2017-10-21T22:21:36Z

Coverage decreased (-0.02%) to 34.013% when pulling 4990c1b on apidocs_update into 61874e3 on master.

syssi · 2017-10-24T06:11:44Z

I will review the PR this week!

rytilahti · 2017-10-24T19:15:46Z

Great, thanks! Running make html inside docs directory generates the documentation, tox -e docs can be used to run the "checks" against the current state.

coveralls · 2017-10-24T19:20:01Z

Coverage increased (+5.4%) to 39.475% when pulling fd0d68c on apidocs_update into 61874e3 on master.

…ater point. Includes also some slight clean-ups.

… & add TODOs

coveralls · 2017-11-18T17:20:55Z

Coverage decreased (-0.01%) to 44.998% when pulling d04570a on apidocs_update into bd5e346 on master.

* Add Iterator import * Remove android_backup documentation as we have moved to use upstream lib

coveralls · 2017-11-18T17:37:26Z

Coverage decreased (-0.03%) to 44.98% when pulling 1518210 on apidocs_update into bd5e346 on master.

coveralls · 2017-11-18T17:37:26Z

Coverage decreased (-0.03%) to 44.98% when pulling 1518210 on apidocs_update into bd5e346 on master.

coveralls · 2017-11-18T18:33:36Z

Coverage decreased (-0.03%) to 44.98% when pulling 62dfaf8 on apidocs_update into bd5e346 on master.

rytilahti · 2017-11-18T18:43:50Z

I will merge this now, we can do adjustments & reviews also after it has been merged (and this allows pointing users to readthedocs for help).

houndci-bot reviewed Oct 19, 2017

View reviewed changes

rytilahti force-pushed the apidocs_update branch from 5923752 to 4990c1b Compare October 21, 2017 22:19

rytilahti changed the title ~~WIP: Update apidocs for sphinx-generated documentation, which follows at l…~~ Update apidocs for sphinx-generated documentation, which follows at l… Oct 21, 2017

rytilahti requested a review from syssi October 21, 2017 22:20

rytilahti mentioned this pull request Nov 7, 2017

Update xiaomi (miio) retrieve token documentation home-assistant/home-assistant.io#3872

Closed

bbbenji mentioned this pull request Nov 16, 2017

Added time left for recommended sensor cleaning #119

Merged

rytilahti added 5 commits November 18, 2017 18:17

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

c9fff49

…ater point. Includes also some slight clean-ups.

Add initial documentation, run make html to generate a html version

2472f54

add docs target for tox, use tox -e docs to run the checks

96237c3

Add more documentation, include --help output from command-line tools…

26a6906

… & add TODOs

add files which were should have been commited with the last commit

d04570a

rytilahti force-pushed the apidocs_update branch from fd0d68c to d04570a Compare November 18, 2017 17:18

Minor fixes

1518210

* Add Iterator import * Remove android_backup documentation as we have moved to use upstream lib

Repository owner deleted a comment from houndci-bot Nov 18, 2017

rytilahti added 2 commits November 18, 2017 19:28

fix links to (api)docs

de12b56

make doc8 happy, run sphinx-build properly during tox

62dfaf8

rytilahti merged commit 2c3d26c into master Nov 18, 2017

rytilahti deleted the apidocs_update branch February 5, 2019 12:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

rytilahti commented Oct 19, 2017 •

edited

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

houndci-bot Oct 19, 2017

coveralls commented Oct 21, 2017 •

edited

syssi commented Oct 24, 2017

rytilahti commented Oct 24, 2017

coveralls commented Oct 24, 2017 •

edited

coveralls commented Nov 18, 2017 •

edited

coveralls commented Nov 18, 2017

coveralls commented Nov 18, 2017 •

edited

coveralls commented Nov 18, 2017 •

edited

rytilahti commented Nov 18, 2017

		]

		intersphinx_mapping = {'python': ('https://docs.python.org/3.6', None)}

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

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

Conversation

rytilahti commented Oct 19, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Oct 21, 2017 • edited

syssi commented Oct 24, 2017

rytilahti commented Oct 24, 2017

coveralls commented Oct 24, 2017 • edited

coveralls commented Nov 18, 2017 • edited

coveralls commented Nov 18, 2017

coveralls commented Nov 18, 2017 • edited

coveralls commented Nov 18, 2017 • edited

rytilahti commented Nov 18, 2017

rytilahti commented Oct 19, 2017 •

edited

coveralls commented Oct 21, 2017 •

edited

coveralls commented Oct 24, 2017 •

edited

coveralls commented Nov 18, 2017 •

edited

coveralls commented Nov 18, 2017 •

edited

coveralls commented Nov 18, 2017 •

edited