Skip to content

Commit ccbb34d

Browse files
committed
[docs] Fixed improper use of code samples in README
1 parent 791b7cd commit ccbb34d

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

README.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -255,8 +255,8 @@ Ping
255255
.. figure:: https://github.com/openwisp/openwisp-monitoring/raw/master/docs/rtt.png
256256
:align: center
257257

258-
``Traffic rx bytes``
259-
~~~~~~~~~~~~~~~~~~~~
258+
Traffic rx bytes
259+
~~~~~~~~~~~~~~~~
260260

261261
+--------------------+-------------------------------+
262262
| **measurement**: | ``<interface_name> rx_bytes`` |
@@ -270,8 +270,8 @@ Ping
270270
| **charts**: | ``traffic`` |
271271
+--------------------+-------------------------------+
272272

273-
``Traffic tx bytes``
274-
~~~~~~~~~~~~~~~~~~~~
273+
Traffic tx bytes
274+
~~~~~~~~~~~~~~~~
275275

276276
+--------------------+-------------------------------+
277277
| **measurement**: | ``<interface_name> tx_bytes`` |
@@ -288,8 +288,8 @@ Ping
288288
.. figure:: https://github.com/openwisp/openwisp-monitoring/raw/master/docs/traffic.png
289289
:align: center
290290

291-
``WiFI Clients``
292-
~~~~~~~~~~~~~~~~
291+
WiFI Clients
292+
~~~~~~~~~~~~
293293

294294
+--------------------+--------------------------+
295295
| **measurement**: | ``<interface_name>`` |
@@ -306,8 +306,8 @@ Ping
306306
.. figure:: https://github.com/openwisp/openwisp-monitoring/raw/master/docs/wifi-clients.png
307307
:align: center
308308

309-
``Memory Usage``
310-
~~~~~~~~~~~~~~~~
309+
Memory Usage
310+
~~~~~~~~~~~~
311311

312312
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------+
313313
| **measurement**: | ``<memory>`` |
@@ -324,8 +324,8 @@ Ping
324324
.. figure:: https://github.com/openwisp/openwisp-monitoring/raw/master/docs/memory.png
325325
:align: center
326326

327-
``CPU Load``
328-
~~~~~~~~~~~~
327+
CPU Load
328+
~~~~~~~~
329329

330330
+--------------------+----------------------------------------------------+
331331
| **measurement**: | ``load`` |
@@ -342,8 +342,8 @@ Ping
342342
.. figure:: https://github.com/openwisp/openwisp-monitoring/raw/master/docs/cpu-load.png
343343
:align: center
344344

345-
``Disk Usage``
346-
~~~~~~~~~~~~~~
345+
Disk Usage
346+
~~~~~~~~~~
347347

348348
+--------------------+-------------------+
349349
| **measurement**: | ``disk`` |
@@ -378,20 +378,20 @@ Default Alerts / Notifications
378378
| | outdated, or device is not reachable). |
379379
+-------------------------------+------------------------------------------------------------------+
380380

381-
``Available Checks``
382-
--------------------
381+
Available Checks
382+
----------------
383383

384-
``Ping``
385-
~~~~~~~~
384+
Ping
385+
~~~~
386386

387387
This check returns information on device ``uptime`` and ``RTT (Round trip time)``.
388388
The Charts ``uptime``, ``packet loss`` and ``rtt`` are created. The ``fping``
389389
command is used to collect these metrics.
390390
You may choose to disable auto creation of this check by setting
391391
`OPENWISP_MONITORING_AUTO_PING <#OPENWISP_MONITORING_AUTO_PING>`_ to ``False``.
392392

393-
``Configuration applied``
394-
~~~~~~~~~~~~~~~~~~~~~~~~~
393+
Configuration applied
394+
~~~~~~~~~~~~~~~~~~~~~
395395

396396
This check ensures that the `openwisp-config agent <https://github.com/openwisp/openwisp-config/>`_
397397
is running and applying configuration changes in a timely manner.
@@ -749,8 +749,8 @@ Registering / Unregistering Metric Configuration
749749
``openwisp_monitoring.monitoring.configuration.register_metric`` and ``openwisp_monitoring.monitoring.configuration.unregister_metric``.
750750
Using these functions you can register or unregister metric configurations from anywhere in your code.
751751

752-
register_metric
753-
~~~~~~~~~~~~~~~
752+
``register_metric``
753+
~~~~~~~~~~~~~~~~~~~
754754

755755
This function is used to register a new metric configuration from anywhere in your code.
756756

@@ -881,8 +881,8 @@ is already registered with same name (not to be confused with verbose_name).
881881
If you don't need to register a new metric but need to change a specific key of an
882882
existing metric configuration, you can use `OPENWISP_MONITORING_METRICS <#openwisp_monitoring_metrics>`_.
883883

884-
unregister_metric
885-
~~~~~~~~~~~~~~~~~
884+
``unregister_metric``
885+
~~~~~~~~~~~~~~~~~~~~~
886886

887887
This function is used to unregister a metric configuration from anywhere in your code.
888888

@@ -911,8 +911,8 @@ Registering / Unregistering Chart Configuration
911911
``openwisp_monitoring.monitoring.configuration.register_chart`` and ``openwisp_monitoring.monitoring.configuration.unregister_chart``.
912912
Using these functions you can register or unregister chart configurations from anywhere in your code.
913913

914-
register_chart
915-
~~~~~~~~~~~~~~
914+
``register_chart``
915+
~~~~~~~~~~~~~~~~~~
916916

917917
This function is used to register a new chart configuration from anywhere in your code.
918918

@@ -955,8 +955,8 @@ is already registered with same name (not to be confused with verbose_name).
955955
If you don't need to register a new chart but need to change a specific key of an
956956
existing chart configuration, you can use `OPENWISP_MONITORING_CHARTS <#openwisp_monitoring_charts>`_.
957957

958-
unregister_chart
959-
~~~~~~~~~~~~~~~~
958+
``unregister_chart``
959+
~~~~~~~~~~~~~~~~~~~~
960960

961961
This function is used to unregister a chart configuration from anywhere in your code.
962962

0 commit comments

Comments
 (0)