[docs] Reformatted

[skip ci]

CHANGES.rst

@@ -13,22 +13,23 @@ Features
 ~~~~~~~~
 
 - Switched to new OpenWISP theme, registered the new menu items
-- Added more REST API endpoint to manipulate details of Topology, Node and Link
+- Added more REST API endpoint to manipulate details of Topology, Node and
+  Link
 
 Changes
 ~~~~~~~
 
 Backward incompatible changes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
++++++++++++++++++++++++++++++
 
 - Changed URL prefix of REST API from to ``/api/v1/topology/``
-  ``/api/v1/network-topology/``
-  for consistency with the other OpenWISP Modules
-- Removed deprecated old receive topology API url;
-  use the new URL: ``/api/v1/network-topology/topology/{id}/receive/``
+  ``/api/v1/network-topology/`` for consistency with the other OpenWISP
+  Modules
+- Removed deprecated old receive topology API url; use the new URL:
+  ``/api/v1/network-topology/topology/{id}/receive/``
 
 Dependencies
-^^^^^^^^^^^^
+++++++++++++
 
 - Dropped support for Python 3.6
 - Added support for Python 3.8 and Python 3.9
@@ -38,14 +39,15 @@ Dependencies
 - Removed redundant django-model-utils (it's defined in openwisp-utils)
 
 Other changes
-^^^^^^^^^^^^^
++++++++++++++
 
 - Moved uuid field of topology admin after main fields
 - Changed "View topology graph" button color
 - Added the `openwisp-utils DjangoModelPermissions
   <https://github.com/openwisp/openwisp-users#djangomodelpermissions>`_
   class to API views
-- Allow nodes, link and topologies to be shared among different organizations
+- Allow nodes, link and topologies to be shared among different
+  organizations
 
 Bugfixes
 ~~~~~~~~
@@ -59,51 +61,63 @@ Version 0.5.1 [2020-11-25]
 --------------------------
 
 - [fix] Removed static() call from media assets
-- [change] Increased `openwisp-users <https://github.com/openwisp/openwisp-users#openwisp-users>`__ version from 0.2.x to 0.5.x
-  (which brings many interesting improvements to multi-tenancy,
-  `see the change log of openwisp-users <https://github.com/openwisp/openwisp-users/blob/master/CHANGES.rst#version-050-2020-11-18>`_
+- [change] Increased `openwisp-users
+  <https://github.com/openwisp/openwisp-users#openwisp-users>`__ version
+  from 0.2.x to 0.5.x (which brings many interesting improvements to
+  multi-tenancy, `see the change log of openwisp-users
+  <https://github.com/openwisp/openwisp-users/blob/master/CHANGES.rst#version-050-2020-11-18>`_
   for more information)
-- Increased `openwisp-utils <https://github.com/openwisp/openwisp-utils#openwisp-utils>`__ version to 0.7.x
+- Increased `openwisp-utils
+  <https://github.com/openwisp/openwisp-utils#openwisp-utils>`__ version
+  to 0.7.x
 
 Version 0.5.0 [2020-09-18]
 --------------------------
 
 Features
 ~~~~~~~~
 
-- Added `integration with OpenWISP Controller and OpenWISP Monitoring <https://github.com/openwisp/openwisp-network-topology#integration-with-openwisp-controller-and-openwisp-monitoring>`_
-- API: added `swagger API docs <https://github.com/openwisp/openwisp-network-topology/#rest-api>`_
+- Added `integration with OpenWISP Controller and OpenWISP Monitoring
+  <https://github.com/openwisp/openwisp-network-topology#integration-with-openwisp-controller-and-openwisp-monitoring>`_
+- API: added `swagger API docs
+  <https://github.com/openwisp/openwisp-network-topology/#rest-api>`_
 - Admin: added UUID readonly field
 - Added user defined properties in Node and Link
 
 Changes
 ~~~~~~~
 
-- **Backward incompatible**: API and visualizer views now require authentication by default.
-  This can be changed through the new
-  `OPENWISP_NETWORK_TOPOLOGY_API_AUTH_REQUIRED <https://github.com/openwisp/openwisp-network-topology#openwisp-network-topology-api-auth-required>`_
+- **Backward incompatible**: API and visualizer views now require
+  authentication by default. This can be changed through the new
+  `OPENWISP_NETWORK_TOPOLOGY_API_AUTH_REQUIRED
+  <https://github.com/openwisp/openwisp-network-topology#openwisp-network-topology-api-auth-required>`_
   setting
 - Upgraded openvpn nodes to netdiff 0.9
 - Automatically manage organization of Node and Link
-- Changed API URL: /api/v1/receive/{id}/ -> /api/v1//topology/{id}/receive/ (old URL kept for backward compatibility)
+- Changed API URL: /api/v1/receive/{id}/ ->
+  /api/v1//topology/{id}/receive/ (old URL kept for backward
+  compatibility)
 
 Bugfixes
 ~~~~~~~~
 
 - Fixed link status bug introduced in 0.4
 - Fixed exceptions during update of data
-- Do not save ``status_changed``, ``modified``, ``created`` in link properties
+- Do not save ``status_changed``, ``modified``, ``created`` in link
+  properties
 - Fixed Topology admin for users who do not have delete permission
 
 Version 0.4.0 [2020-06-28]
 --------------------------
 
-- [refactoring] Merged code of django-netjsongraph in openwisp-network-topology
+- [refactoring] Merged code of django-netjsongraph in
+  openwisp-network-topology
 - [**breaking change**]: URLS at ``/api/`` moved to ``/api/v1/``
 - [docs] Reordered & Improved docs
 - [add] Requirement swapper~=1.1
 - [docs] Added tutorial for extending openwisp-network-topology
-- [feature] Upgrader script to upgrade from django-netjsongraph to openwisp-network-topology
+- [feature] Upgrader script to upgrade from django-netjsongraph to
+  openwisp-network-topology
 - [change] Requirement netdiff~=0.8.0
 
 Version 0.3.2 [2020-06-02]
@@ -132,32 +146,37 @@ Version 0.2.2 [2020-01-13]
 --------------------------
 
 - Updated dependencies
-- Upgraded implementation of node addresses (via django-netjsongraph 0.5.0)
+- Upgraded implementation of node addresses (via django-netjsongraph
+  0.5.0)
 
 Version 0.2.1 [2018-02-24]
 --------------------------
 
 - `fe9077c <https://github.com/openwisp/openwisp-network-topology/commit/fe9077c>`_:
-   [models] Fixed related name of Link.target
+      [models] Fixed related name of Link.target
 
 Version 0.2.0 [2018-02-20]
 --------------------------
 
 - `cb7366 <https://github.com/openwisp/openwisp-network-topology/commit/cb7366>`_:
-   [migrations] Added a migration file for link_status_changed and openvpn_parser
+      [migrations] Added a migration file for link_status_changed and
+      openvpn_parser
 - `#22 <https://github.com/openwisp/openwisp-network-topology/pull/22>`_:
   Added support to django 2.0
-- `d40032 <https://github.com/openwisp/openwisp-network-topology/commit/d40032>`_:
+- `d40032
+  <https://github.com/openwisp/openwisp-network-topology/commit/d40032>`_:
   [qa] Fixed variable name error
-- `de45b6 <https://github.com/openwisp/openwisp-network-topology/commit/de45b6>`_:
+- `de45b6
+  <https://github.com/openwisp/openwisp-network-topology/commit/de45b6>`_:
   Upgraded code according to latest django-netjsongraph 0.4.0 changes
 - `#17 <https://github.com/openwisp/openwisp-network-topology/pull/17>`_:
   Integrated topology history feature from django-netjsongraph
 
 Version 0.1.2 [2017-07-22]
 --------------------------
 
-- `#13 <https://github.com/openwisp/openwisp-network-topology/issues/13>`_:
+- `#13
+  <https://github.com/openwisp/openwisp-network-topology/issues/13>`_:
   Fixed the fetch and receive API bugs
 - `#15 <https://github.com/openwisp/openwisp-network-topology/pull/15>`_:
   Imported admin tests from django-netjsongraph
@@ -167,9 +186,13 @@ Version 0.1.2 [2017-07-22]
 Version 0.1.1 [2017-07-10]
 --------------------------
 
-- `95f8ade <https://github.com/openwisp/openwisp-network-topology/commit/95f8ade>`_: [admin] Moved submit_line.html to `openwisp-utils <https://github.com/openwisp/openwisp-utils>`_
+- `95f8ade
+  <https://github.com/openwisp/openwisp-network-topology/commit/95f8ade>`_:
+  [admin] Moved submit_line.html to `openwisp-utils
+  <https://github.com/openwisp/openwisp-utils>`_
 
 Version 0.1 [2017-06-29]
 ------------------------
 
-- Added multi-tenancy and integrated `django-netjsongraph <https://github.com/netjson/django-netjsongraph>`_
+- Added multi-tenancy and integrated `django-netjsongraph
+  <https://github.com/netjson/django-netjsongraph>`_

README.rst

@@ -48,17 +48,15 @@ store it, visualize it, edit its details, it also provides hooks (a.k.a
 to execute code when the status of a link changes.
 
 For a complete overview of features, refer to the `Network Topology:
-Features
-<https://openwisp.io/docs/dev/network-topology/user/intro.html>`_
+Features <https://openwisp.io/docs/dev/network-topology/user/intro.html>`_
 section of the OpenWISP documentation.
 
 Documentation
 -------------
 
 - `Developer documentation
   <https://openwisp.io/docs/dev/network-topology/developer/>`_
-- `User documentation
-  <https://openwisp.io/docs/dev/network-topology/>`_
+- `User documentation <https://openwisp.io/docs/dev/network-topology/>`_
 
 Contributing
 ------------

docs/developer/extending.rst

@@ -3,9 +3,10 @@ Extending OpenWISP Network Topology
 
 .. include:: ../partials/developer-docs.rst
 
-One of the core values of the OpenWISP project is :ref:`Software Reusability <values_software_reusability>`,
-for this reason *openwisp-network-topology* provides a set of base classes
-which can be imported, extended and reused to create derivative apps.
+One of the core values of the OpenWISP project is :ref:`Software
+Reusability <values_software_reusability>`, for this reason
+*openwisp-network-topology* provides a set of base classes which can be
+imported, extended and reused to create derivative apps.
 
 In order to implement your custom version of *openwisp-network-topology*,
 you need to perform the steps described in this section.

docs/index.rst

@@ -6,21 +6,23 @@ Network Topology
     **Source code**: `github.com/openwisp/openwisp-network-topology
     <https://github.com/openwisp/openwisp-network-topology>`_.
 
-OpenWISP Network Topology is a network topology collector and visualizer web application
-and API, it allows to collect network topology data from different networking software
-(dynamic mesh routing protocols, OpenVPN), store it, visualize it, edit its details, it
-also provides hooks (a.k.a `Django signals
-<https://docs.djangoproject.com/en/3.1/topics/signals/>`_) to execute code when the
-status of a link changes.
+OpenWISP Network Topology is a network topology collector and visualizer
+web application and API, it allows to collect network topology data from
+different networking software (dynamic mesh routing protocols, OpenVPN),
+store it, visualize it, edit its details, it also provides hooks (a.k.a
+`Django signals <https://docs.djangoproject.com/en/3.1/topics/signals/>`_)
+to execute code when the status of a link changes.
 
-When used in conjunction with :doc:`OpenWISP Controller </controller/index>` and
-:doc:`OpenWISP Monitoring </monitoring/index>`, it :doc:`makes the monitoring system
-faster in detecting change to the network <./user/integrations>`.
+When used in conjunction with :doc:`OpenWISP Controller
+</controller/index>` and :doc:`OpenWISP Monitoring </monitoring/index>`,
+it :doc:`makes the monitoring system faster in detecting change to the
+network <./user/integrations>`.
 
-For a comprehensive overview of features, please refer to the :doc:`user/intro` page.
+For a comprehensive overview of features, please refer to the
+:doc:`user/intro` page.
 
-The following diagram illustrates the role of the Network Topology module within the
-OpenWISP architecture.
+The following diagram illustrates the role of the Network Topology module
+within the OpenWISP architecture.
 
 .. figure:: images/architecture-v2-openwisp-network-topology.png
     :target: ../_images/architecture-v2-openwisp-network-topology.png
@@ -31,7 +33,8 @@ OpenWISP architecture.
 
 .. important::
 
-    For an enhanced viewing experience, open the image above in a new browser tab.
+    For an enhanced viewing experience, open the image above in a new
+    browser tab.
 
     Refer to :doc:`/general/architecture` for more information.
 

docs/user/intro.rst

@@ -28,5 +28,5 @@ visualizing, and monitoring network topologies. Key features include:
 - **topology history**: allows saving daily snapshots of each topology
   that can be viewed in the frontend
 - **faster monitoring**: :doc:`integrates with OpenWISP Controller and
-  OpenWISP Monitoring <integrations>` for faster
-  detection of critical events in the network
+  OpenWISP Monitoring <integrations>` for faster detection of critical
+  events in the network

docs/user/management-commands.rst

@@ -93,8 +93,8 @@ django-netjsongraph
 
 This management command can be used to create the initial ``DeviceNode``
 relationships when the :doc:`integration with OpenWISP Controller
-<integrations>` is enabled in a pre-existing system
-which already has some devices and topology objects in its database.
+<integrations>` is enabled in a pre-existing system which already has some
+devices and topology objects in its database.
 
 .. code-block:: shell
 

docs/user/settings.rst

@@ -129,5 +129,4 @@ monitoring agent.
     The network topology objects are created using the device monitoring
     data collected by OpenWISP Monitoring. Thus, it requires
     :doc:`integration with OpenWISP Controller and OpenWISP Monitoring
-    <integrations>` to be enabled in the Django
-    project.
+    <integrations>` to be enabled in the Django project.