Skip to content

Commit 3cf15cb

Browse files
committed
Diminished the duplication of effort at the documentation by
referencing sections at the README file. Altered the testing section in the development.rst file.
1 parent 7f596f8 commit 3cf15cb

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

docs/development.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,9 @@ Code Style Guide
3434
Testing
3535
-------
3636

37-
Tests are implemented using the ``py.test`` framework and are located
38-
in the tests/ directory. Their module name typically resembles the full
39-
path of the module they're testing. However, we recommend the usage of
40-
``tox`` as it will test our codebase against both Python 2.7 and 3.0.
37+
Tests make use of the ``py.test`` framework and are located in the tests/
38+
folder. However, we recommend the usage of ``tox`` as it will test our
39+
codebase against both Python 2.7 and 3.0.
4140

4241
.. include:: ../README.rst
4342
:start-after: _testing_content_start:

docs/index.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
Zeroless
44
========
55

6-
|Build Status| |Coverage Status| |Codacy| |PyPi| |Docs| |License|
6+
.. include:: ../README.rst
7+
:start-after: _badges_start:
8+
:end-before: _badges_end:
79

810
This documentation contains notes on some important aspects of developing Zeroless
911
and an overview of Zeroless' API. For information on how to use ØMQ_ in general,
@@ -34,9 +36,9 @@ Installing
3436

3537
Install stable releases of Zeroless with ``pip``.
3638

37-
.. code-block:: bash
38-
39-
$ pip install zeroless
39+
.. include:: ../README.rst
40+
:start-after: _install_content_start:
41+
:end-before: _install_content_end:
4042

4143
See the :doc:`install` for more detail.
4244

docs/install.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Install Guide
55

66
Install stable releases of Zeroless with ``pip``.
77

8-
.. code-block:: bash
9-
10-
$ pip install zeroless
8+
.. include:: ../README.rst
9+
:start-after: _install_content_start:
10+
:end-before: _install_content_end:
1111

1212
.. _install_dependencies:
1313

0 commit comments

Comments
 (0)