Skip to content

Commit

Permalink
[docs] Minor docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
nemesifier committed May 17, 2024
1 parent 052d14c commit 9d43d2d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ netjsonconfig

.. image:: https://img.shields.io/librariesio/release/github/openwisp/netjsonconfig
:target: https://libraries.io/github/openwisp/netjsonconfig#repository_dependencies
:alt: Dependency monitoring
:alt: Dependency monitoring

.. image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square
:target: https://gitter.im/openwisp/general
Expand All @@ -35,7 +35,7 @@ configuration engine of `OpenWISP 2 <https://github.com/openwisp/ansible-openwis

**netjsonconfig** is a python library that converts `NetJSON <http://netjson.org>`_
*DeviceConfiguration* objects into real router configurations that can be installed
on systems like `OpenWRT <http://openwrt.org>`_, `LEDE <https://www.lede-project.org/>`_
on systems like `OpenWRT <http://openwrt.org>`_,
or `OpenWisp Firmware <https://github.com/openwisp/OpenWISP-Firmware>`_.

Its main features are listed below for your reference:
Expand Down
7 changes: 7 additions & 0 deletions docs/source/general/running_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ Alternatively, you can use the ``nose2`` tool (which has a ton of available opti
nose2
Run specific test files:

.. code-block:: shell
# runs tests.openwrt.test_network
nose2 -s tests/openwrt/ -v test_network
See test coverage with:

.. code-block:: shell
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ configuration engine of `OpenWISP 2 <https://github.com/openwisp/ansible-openwis

**netjsonconfig** is a python library that converts `NetJSON <http://netjson.org>`_
*DeviceConfiguration* objects into real router configurations that can be installed
on systems like `OpenWRT <http://openwrt.org>`_, `LEDE <https://www.lede-project.org/>`_
on systems like `OpenWRT <http://openwrt.org>`_,
or `OpenWisp Firmware <https://github.com/openwisp/OpenWISP-Firmware>`_.

Its main features are:
Expand Down

0 comments on commit 9d43d2d

Please sign in to comment.