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.

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

Documentation updates #56

Merged
merged 3 commits into from
May 23, 2020
Merged

Documentation updates #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
67d7f6b
updated conf.py
sonelu May 22, 2020
f0010a4
doc updates
sonelu May 23, 2020
638bcf4
allow failured on ARM64 builds on travis
sonelu May 23, 2020
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
2 changes: 2 additions & 0 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ install:
- pip install .[all]
jobs:
fast_finish: true
allow_failures:
- arch: arm64
include:
- stage: AMD64
python: 3.6
Expand Down
38 changes: 3 additions & 35 deletions docs/_templates/autosummary/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,6 @@

.. autoclass:: {{ objname }}
:show-inheritance:

{% block methods %}

{% if methods %}
.. rubric:: Methods

.. autosummary::

{% for item in methods %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}

{% block attributes %}
{% if attributes %}
.. rubric:: Attributes

.. autosummary::
{% for item in attributes %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}

{% block ext_methods %}

{% if methods %}
.. rubric:: Methods in detail

{% for item in methods %}
.. automethod:: {{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
:inherited-members:
:members:
:special-members:
19 changes: 11 additions & 8 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,23 @@
'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
'sphinx_rtd_theme'
'sphinx_rtd_theme',
'sphinx.ext.todo'
]

# Display todos by setting to True
todo_include_todos = True

# generate autosummary pages
autosummary_generate = True
autodoc_default_options = {
# 'members': 'var1, var2',
# 'member-order': 'bysource',
'special-members': True,
# 'special-members': '__init__',
'undoc-members': True,
'private-members': True,
'exclude-members': '__weakref__'
# # 'members': 'var1, var2',
'member-order': 'bysource',
# 'special-members': '__init__, __sub__',
# # 'special-members': '__init__',
# 'undoc-members': True,
# 'private-members': True,
'exclude-members': '__weakref__'
}

# If true, the current module name will be prepended to all description
Expand Down
4 changes: 3 additions & 1 deletion docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ You can install roboglia without installing the hardware dependencies, but
when you will use it you must have those dependencies available otherwise
Python will raise an ``No module`` exception.

You can install roboglia using pip::
You can install roboglia using pip:

.. code::

pip install roboglia

Expand Down
47 changes: 3 additions & 44 deletions docs/reference/base/roboglia.base.BaseBus.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,47 +5,6 @@ roboglia.base.BaseBus

.. autoclass:: BaseBus
:show-inheritance:




.. rubric:: Methods

.. autosummary::


~BaseBus.__init__
~BaseBus.close
~BaseBus.open
~BaseBus.read
~BaseBus.write





.. rubric:: Attributes

.. autosummary::

~BaseBus.auto_open
~BaseBus.is_open
~BaseBus.name
~BaseBus.port
~BaseBus.robot






.. rubric:: Methods in detail


.. automethod:: __init__
.. automethod:: close
.. automethod:: open
.. automethod:: read
.. automethod:: write


:inherited-members:
:members:
:special-members:
53 changes: 3 additions & 50 deletions docs/reference/base/roboglia.base.BaseDevice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,53 +5,6 @@ roboglia.base.BaseDevice

.. autoclass:: BaseDevice
:show-inheritance:




.. rubric:: Methods

.. autosummary::


~BaseDevice.__init__
~BaseDevice.close
~BaseDevice.default_register
~BaseDevice.get_model_path
~BaseDevice.open
~BaseDevice.read_register
~BaseDevice.register_by_address
~BaseDevice.write_register





.. rubric:: Attributes

.. autosummary::

~BaseDevice.bus
~BaseDevice.cache
~BaseDevice.dev_id
~BaseDevice.name
~BaseDevice.registers






.. rubric:: Methods in detail


.. automethod:: __init__
.. automethod:: close
.. automethod:: default_register
.. automethod:: get_model_path
.. automethod:: open
.. automethod:: read_register
.. automethod:: register_by_address
.. automethod:: write_register


:inherited-members:
:members:
:special-members:
59 changes: 3 additions & 56 deletions docs/reference/base/roboglia.base.BaseLoop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,59 +5,6 @@ roboglia.base.BaseLoop

.. autoclass:: BaseLoop
:show-inheritance:




.. rubric:: Methods

.. autosummary::


~BaseLoop.__init__
~BaseLoop.atomic
~BaseLoop.pause
~BaseLoop.resume
~BaseLoop.run
~BaseLoop.setup
~BaseLoop.start
~BaseLoop.stop
~BaseLoop.teardown





.. rubric:: Attributes

.. autosummary::

~BaseLoop.frequency
~BaseLoop.name
~BaseLoop.paused
~BaseLoop.period
~BaseLoop.review
~BaseLoop.running
~BaseLoop.started
~BaseLoop.stopped
~BaseLoop.warning






.. rubric:: Methods in detail


.. automethod:: __init__
.. automethod:: atomic
.. automethod:: pause
.. automethod:: resume
.. automethod:: run
.. automethod:: setup
.. automethod:: start
.. automethod:: stop
.. automethod:: teardown


:inherited-members:
:members:
:special-members:
69 changes: 3 additions & 66 deletions docs/reference/base/roboglia.base.BaseReadSync.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,69 +5,6 @@ roboglia.base.BaseReadSync

.. autoclass:: BaseReadSync
:show-inheritance:




.. rubric:: Methods

.. autosummary::


~BaseReadSync.__init__
~BaseReadSync.atomic
~BaseReadSync.get_register_range
~BaseReadSync.pause
~BaseReadSync.process_devices
~BaseReadSync.process_registers
~BaseReadSync.resume
~BaseReadSync.run
~BaseReadSync.setup
~BaseReadSync.start
~BaseReadSync.stop
~BaseReadSync.teardown





.. rubric:: Attributes

.. autosummary::

~BaseReadSync.auto_start
~BaseReadSync.bus
~BaseReadSync.devices
~BaseReadSync.frequency
~BaseReadSync.name
~BaseReadSync.paused
~BaseReadSync.period
~BaseReadSync.registers
~BaseReadSync.review
~BaseReadSync.running
~BaseReadSync.started
~BaseReadSync.stopped
~BaseReadSync.warning






.. rubric:: Methods in detail


.. automethod:: __init__
.. automethod:: atomic
.. automethod:: get_register_range
.. automethod:: pause
.. automethod:: process_devices
.. automethod:: process_registers
.. automethod:: resume
.. automethod:: run
.. automethod:: setup
.. automethod:: start
.. automethod:: stop
.. automethod:: teardown


:inherited-members:
:members:
:special-members:
Loading