Skip to content

Conversation

@chrisn-au
Copy link
Contributor

@chrisn-au chrisn-au commented Nov 23, 2023

Gents, I have done a bit of work to restructure the documentation and provide the basis to extend from. Thank you for the support to get to this point.

The documentation builds cleanly

autosummary] generating autosummary for: api_commands.rst, error.rst, index.rst, status.rst, usage.rst
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://www.sphinx-doc.org/en/master/objects.inv...
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 5 source files that are out of date
updating environment: [new config] 5 added, 0 changed, 0 removed
reading sources... [100%] usage
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] usage
generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done

====================== slowest reading durations =======================
0.285 api_commands
0.009 error
0.009 status
0.005 usage
0.004 index
build succeeded.

and is grouped by logical command grouping (acknowledging that this is subjective)

I will continue to make changes (tested on my Roborock s8 Pro Ultra) however will wait until this pull request is approved

Feel free to reach out with questions

Lash-L
Lash-L previously approved these changes Nov 24, 2023
Copy link
Collaborator

@Lash-L Lash-L left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good - some reviews that can be addressed in a follow up. Merging this for now just to help with readability and changes

@Lash-L
Copy link
Collaborator

Lash-L commented Nov 24, 2023

oh was gonna merge - but could you run pre-commit.

Ignore the lint commit message but the other lint needs to pass

@Lash-L Lash-L merged commit 38498a3 into Python-roborock:main Nov 29, 2023
@Lash-L
Copy link
Collaborator

Lash-L commented Nov 29, 2023

Forgot to change the commit title, but should be okay with my next merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants