Skip to content

Commit 2d82b17

Browse files
committed
Add testing and docs sections
1 parent a1458f4 commit 2d82b17

File tree

1 file changed

+40
-3
lines changed

1 file changed

+40
-3
lines changed

docs/contributing.rst

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,6 @@ Class docstring to document (at least) public methods:
151151
152152
.. }}}
153153
154-
155154
.. PROTOCOLS {{{2
156155
157156
=========
@@ -166,7 +165,7 @@ If you want to add a new protocol please look at the ``minicps/protocols.py``
166165
module. ``Protocol`` is the base class, and the
167166
``NewProtocolNameProtocol(Protocol)`` should be your new child class containing
168167
the code to manage it. A good point to start it to take a look
169-
at ``minicps/tests/protocols_tests.py`` to see how other protocols classes
168+
at ``tests/protocols_tests.py`` to see how other protocols classes
170169
are unit-tested.
171170

172171
If you want to improve the compatibility of a supported protocol please take
@@ -182,7 +181,20 @@ the Modbus protocol support.
182181
States
183182
======
184183

185-
The same reasoning presented in the Protocols section applies here.
184+
The same reasoning presented in the Protocols section applies here. The
185+
relevant source code is located in ``minicps/states.py`` and
186+
``tests/states_tests.py``.
187+
188+
.. }}}
189+
190+
.. TESTING {{{2
191+
192+
========
193+
Testing
194+
========
195+
196+
Unit testing is hard to setup properly! Please if you find any inconsistent unit test or
197+
decomposable unit test or you want to add a new one.
186198

187199
.. }}}
188200
@@ -197,5 +209,30 @@ in the ``examples`` directory.
197209

198210
.. }}}
199211
212+
.. DOCS {{{2
213+
214+
========
215+
Docs
216+
========
217+
218+
All the docs are stored in the ``docs`` folder. We are using ``sphinx`` to
219+
render the docs and the ``rst`` markup language to write them. Some of the
220+
docs are automatically generated from the code and others are written by
221+
hands.
222+
223+
To build you documentation locally use one of the target of the ``Makefile``
224+
present in the ``docs`` folder. For example, to build and navigate an html
225+
version of our docs type:
226+
227+
.. code-block:: console
228+
229+
cd docs
230+
make html
231+
firefox _build/html/index.html
232+
233+
Please send a PR if you find any typo, incorrect explanation, etc.
234+
235+
.. }}}
236+
200237
.. }}}
201238

0 commit comments

Comments
 (0)