Skip to content

add more documentation #37

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.

Sign up for GitHub

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

Jump to bottom
Merged
jluebbe merged 11 commits into from
Mar 22, 2017
Merged

add more documentation #37

jluebbe merged 11 commits into from
Mar 22, 2017

Conversation

@Emantor
Copy link
Member

@Emantor Emantor commented Mar 21, 2017

No description provided.

@Emantor Emantor requested a review from jluebbe March 21, 2017 07:15
@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage decreased (-0.2%) to 47.925% when pulling 2d7ba5e on Emantor:topic/docs2 into 4e1832b on labgrid-project:master.

@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage decreased (-0.2%) to 47.925% when pulling d89528c on Emantor:topic/docs2 into 4e1832b on labgrid-project:master.

@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage decreased (-0.2%) to 47.925% when pulling d89528c on Emantor:topic/docs2 into 4e1832b on labgrid-project:master.

@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage decreased (-0.2%) to 47.925% when pulling b78612b on Emantor:topic/docs2 into 4e1832b on labgrid-project:master.

@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage remained the same at 48.084% when pulling b85a363 on Emantor:topic/docs2 into 4e1832b on labgrid-project:master.

@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage decreased (-0.2%) to 47.925% when pulling b85a363 on Emantor:topic/docs2 into 4e1832b on labgrid-project:master.

@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage decreased (-0.2%) to 47.925% when pulling 59bb2ee on Emantor:topic/docs2 into 4e1832b on labgrid-project:master.

@Emantor Emantor added this to the labgrid 0.1 milestone Mar 21, 2017
@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage decreased (-0.2%) to 47.855% when pulling f556147 on Emantor:topic/docs2 into 4e1832b on labgrid-project:master.

@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage decreased (-0.2%) to 47.855% when pulling 7f765e5 on Emantor:topic/docs2 into 4e1832b on labgrid-project:master.

@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage decreased (-0.2%) to 47.855% when pulling 6c8306e on Emantor:topic/docs2 into be2225d on labgrid-project:master.

@Emantor Emantor force-pushed the topic/docs2 branch 4 times, most recently from 83a0498 to 71deefd Compare March 21, 2017 14:27
@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage remained the same at 47.704% when pulling 83a0498 on Emantor:topic/docs2 into 694b3a4 on labgrid-project:master.

@Emantor Emantor changed the title [WIP] Topic/docs2 [RDY] Topic/docs2 Mar 21, 2017
@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage remained the same at 47.704% when pulling 71deefd on Emantor:topic/docs2 into 694b3a4 on labgrid-project:master.

jluebbe
jluebbe requested changes Mar 21, 2017
View reviewed changes
Copy link
Member

@jluebbe jluebbe left a comment

Choose a reason for hiding this comment

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

Maybe also squash some documentation commits for the same files.

README.rst

.. code-block:: bash
$ sudo apt install libow-dev
Copy link
Member

@jluebbe jluebbe Mar 21, 2017

Choose a reason for hiding this comment

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

We should document this requirement somewhere else.

Copy link
Member Author

@Emantor Emantor Mar 21, 2017

Choose a reason for hiding this comment

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

It's now documented in the usage/installation/extras requires section.

doc/components.rst Outdated
CommandProtocol
------------
---------------
.. autoclass:: labgrid.protocol.CommandProtocol
Copy link
Member

@jluebbe jluebbe Mar 21, 2017

Choose a reason for hiding this comment

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

The CommandProtocol is not a driver.

Copy link
Member Author

@Emantor Emantor Mar 21, 2017

Choose a reason for hiding this comment

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

I started to group the Drivers by Protocol, but since we can just list their base classes I will remove that.

doc/usage.rst Outdated
Installation
------------

The default installation is available via Pypi:
Copy link
Member

@jluebbe jluebbe Mar 21, 2017

Choose a reason for hiding this comment

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

PyPI instead of Pypi.

doc/usage.rst
Labgrid supports different extras:

- onewire: install onewire support, requires onewire from pypi >=0.0.2
- coordinator: installs required depencies to start a crossbar coordinator
Copy link
Member

@jluebbe jluebbe Mar 21, 2017

Choose a reason for hiding this comment

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

Add an example how to enable both extras.

Emantor added 5 commits March 21, 2017 18:36
@Emantor
doc/components: show inheritance in autoclasses and remove sections
103fd61 
Also add autoclasses for some Drivers.

Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
@Emantor
doc: switch to read the docs theme and add sphinxcontrib-napoleon
24c6627 
Napoleon enables the automatic conversion from google style docstrings to rst
sphinx docstrings. Also fix the mocks to allow apidoc to parse the authenticator
and remove the static html path for now.

Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
@Emantor
config: fix docstring indentation
38fc3b4 
Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
@Emantor
doc: add new doc-requirements, to allow package installation on rtd
35ab6db 
Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
@Emantor
readme: remove libow-dev, it's no longer mandatory
d23049c 
Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
Emantor added 2 commits March 21, 2017 18:36
@Emantor
docs,setup: add coordinator extra and document it
de611a3 
Add a new installation section which documents how to use the extras.

Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
@Emantor
travis: build documentation
30609ab 
Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
@Emantor
Copy link
Member Author

Emantor commented Mar 21, 2017

Squashed it some more, fixed the suggestions.

@coveralls
Copy link

coveralls commented Mar 21, 2017

Coverage Status

Coverage increased (+0.2%) to 47.862% when pulling 30609ab on Emantor:topic/docs2 into 694b3a4 on labgrid-project:master.

Emantor added 4 commits March 22, 2017 09:19
@Emantor
doc/getting_started: distributed tutorial, udev matching
14b3860 
Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
@Emantor
doc/usage: fix headline
263bc3d 
Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
@Emantor
doc/components: Fix headlines and add more drivers and strategies
d9a523b 
Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
@Emantor
doc/index: add purpose as introduction
82aea0b 
Signed-off-by: Rouven Czerwinski <r.czerwinski@pengutronix.de>
@coveralls
Copy link

coveralls commented Mar 22, 2017

Coverage Status

Coverage increased (+0.2%) to 47.862% when pulling 82aea0b on Emantor:topic/docs2 into 694b3a4 on labgrid-project:master.

@coveralls
Copy link

coveralls commented Mar 22, 2017

Coverage Status

Coverage remained the same at 47.704% when pulling 82aea0b on Emantor:topic/docs2 into 694b3a4 on labgrid-project:master.

@jluebbe jluebbe merged commit e63bd00 into labgrid-project:master Mar 22, 2017
@jluebbe jluebbe changed the title [RDY] Topic/docs2 add more documentation Mar 22, 2017
@Emantor Emantor deleted the topic/docs2 branch March 22, 2017 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jluebbe jluebbe jluebbe approved these changes

Assignees

@jluebbe jluebbe

Labels

documentation

Projects

None yet

Milestone

v0.1.0

Development

Successfully merging this pull request may close these issues.

3 participants

@Emantor @coveralls @jluebbe