Skip to content

Commit 9e8abbd

Browse files
committed
#47 Add component info. Add support PluginsManager v0.7.0
1 parent a0f8d06 commit 9e8abbd

File tree

3 files changed

+20
-13
lines changed

3 files changed

+20
-13
lines changed

README.rst

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,10 @@ For example, you have a **Raspberry Pi B+** and a **PC**.
173173
Creating a component
174174
--------------------
175175

176-
Subsequently you will be added in the documentation details on how to create a component for the Pedal Pi.
177-
It is currently recommended to view the API documentation.
176+
Subsequently will be added details in the documentation on how to create a component for the Pedal Pi.
177+
For now, you can check the blog post `Building a Pedal Pi Component - Pedalboard selector`_
178+
179+
.. _Building a Pedal Pi Component - Pedalboard selector: https://pedalpi.github.io/blog/building-a-pedal-pi-component-pedalboard-selector.html
178180

179181
Maintenance
180182
-----------
@@ -189,10 +191,8 @@ The purpose of the tests is:
189191

190192
.. code-block:: bash
191193
192-
coverage3 run --source=application setup.py test
193-
coverage3 report
194-
coverage3 html
195-
firefox htmlcov/index.html
194+
make test
195+
make test-details
196196
197197
Generate documentation
198198
**********************
@@ -203,12 +203,10 @@ You can generate the documentation in your local machine:
203203

204204
.. code-block:: bash
205205
206-
pip3 install sphinx
207-
208-
cd docs
209-
make html
206+
make install-docs-requirements
207+
make docs
210208
211-
firefox build/html/index.html
209+
make docs-see
212210
213211
.. _Sphinx: http://www.sphinx-doc.org/
214212
.. _Read the Docs: http://readthedocs.org

docs/source/component.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
PedalPi - Application - Component
22
=================================
33

4+
Creating a component
5+
--------------------
6+
7+
Subsequently will be added details on how to create a component for the Pedal Pi.
8+
For now, you can check the blog post `Building a Pedal Pi Component - Pedalboard selector`_
9+
10+
.. _Building a Pedal Pi Component - Pedalboard selector: https://pedalpi.github.io/blog/building-a-pedal-pi-component-pedalboard-selector.html
11+
412

513
Component
614
---------
@@ -25,3 +33,4 @@ CurrentPedalboardObserver
2533
:members:
2634
:special-members:
2735
:exclude-members: __weakref__
36+

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def readme():
2424

2525
setup(
2626
name='PedalPi-Application',
27-
version='0.3.0',
27+
version='0.4.0',
2828

2929
description='Framework for manager the Pedal Pi',
3030
long_description=readme(),
@@ -52,7 +52,7 @@ def readme():
5252
package_data={
5353
'application/data': ['*.json', '*/*.json'],
5454
},
55-
install_requires=['PedalPi-PluginsManager>=0.5.0'],
55+
install_requires=['PedalPi-PluginsManager==0.7.0'],
5656

5757
test_suite='test',
5858
tests_requires=['PedalPi-PluginsManager'],

0 commit comments

Comments
 (0)