Lint RST.

Signed-off-by: Volker Theile <votdev@gmx.de>

.rstcheck.cfg

@@ -0,0 +1,5 @@
+[rstcheck]
+report_level=WARNING
+ignore_directives=automodule,autosummary,autoclass
+ignore_messages=(Undefined substitution referenced: "(omv|webui|version|sf|copy)")
+ignore_roles=fa

Makefile

@@ -34,6 +34,12 @@ help:
 clean:
 	rm -rf "$(BUILDDIR)"
 
+lint:
+	( \
+		. $(VENVDIR)/bin/activate; \
+		rstcheck --recursive *.rst ./administration ./development ./installation ./various \
+	)
+
 .PHONY: autobuild buildvenv clean help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new

administration/general/notifications.rst

@@ -107,9 +107,9 @@ Your script's filename must adhere to the following standards:
 
 	- Must belong to one or more of the following namespaces:
 
-		- The LANANA-assigned namespace (^[a-z0-9]+$)
-		- The LSB hierarchical and reserved namespaces (^_?([a-z0-9_.]+-)+[a-z0-9]+$)
-		- The Debian cron script namespace (^[a-zA-Z0-9_-]+$)
+		- The LANANA-assigned namespace (``^[a-z0-9]+$``)
+		- The LSB hierarchical and reserved namespaces (``^_?([a-z0-9_.]+-)+[a-z0-9]+$``)
+		- The Debian cron script namespace (``^[a-zA-Z0-9_-]+$``)
 
 	- Start with a number like this: :file:`<##>pushnotification`
 

development/tools/omv_confdbadm.rst

@@ -59,8 +59,7 @@ Output returns:
 	        "passno": 0,
 	        "type": "none",
 	        "uuid": "dce89b85-f1e1-42e2-8d46-986de599abff"
-	    },
-
+	    }
 	]
 
 

faq.rst

@@ -84,12 +84,12 @@ How can I modify an internal value of some service |omv| has control over?
 	Read :doc:`here <various/advset>` for advanced configurations.
 
 How can I modify or add a network configuration with some custom options the |webui| does not provide?
-    Starting with |omv| version 5 ``systemd-networkd`` is used to configure the network.
+    Starting with |omv| version 5 `systemd-networkd` is used to configure the network.
     The interfaces file :file:`/etc/network/interfaces` is controlled by |omv| but
     not used anymore.
     To add network interfaces that are not configurable through the |webui| or other
     options not present, use :doc:`advanced settings <various/advset>`.
-    Alternatively write your own ``systemd-networkd`` configuration files.
+    Alternatively write your own `systemd-networkd` configuration files.
 
 Why my disks mount paths have a long alphanumeric number?
 	The long number is called UUID, it is used by fstab to mount disks. This

features.rst

@@ -73,11 +73,11 @@ Diagnostics
 
 **Services:** View status (enabled/disabled and running/not running) of services. Detailed information is provided by default for Samba, FTP and SSH. Plugins can use this tab to integrate their service information also.
 
-.. [1] http://postfix.org
+.. [1] https://www.postfix.org/
 .. [2] https://www.avahi.org/
 .. [3] https://www.smartmontools.org/
 .. [4] https://raid.wiki.kernel.org/index.php/RAID_setup
 .. [5] https://www.samba.org/
 .. [6] http://www.proftpd.org/
-.. [7] http://nfs.sourceforge.net/
+.. [7] https://nfs.sourceforge.net/
 .. [8] https://www.openssh.com/

requirements.txt

@@ -1,3 +1,4 @@
+rstcheck
 sphinx
 sphinx-autobuild
 sphinx_rtd_theme

troubleshooting.rst

@@ -1,7 +1,6 @@
 Troubleshooting
 ===============
 
-
 * **The web interface has missing fields and/or items showing that have been uninstalled.**
 
     Clear your browser cache.
@@ -37,19 +36,19 @@ Troubleshooting
 
 * **How to troubleshoot an error caused by an "Option" parameter passed to a plug-in**
 
-    To find the root cause, run the faulty systemd unit file yourself by executing:
-	#
-	systemd restart <plug-in-daemon>
+    To find the root cause, run the faulty systemd unit file yourself by executing::
+
+        systemd restart <plug-in-daemon>
 
-	If output of <plug-in> is now more vebose, then you will get a hint on STDOUT. If not, then you need to run journalctl -f in parallel to get the syslog output. Admittedly, not really novice friendly, but it's really not possible to do it any other way. OMV always tries to be as error/debug friendly as possible; by default.
+    If output of <plug-in> is now more verbose, then you will get a hint on STDOUT. If not, then you need to run ``journalctl -f`` in parallel to get the syslog output. Admittedly, not really novice friendly, but it's really not possible to do it any other way. OMV always tries to be as error/debug friendly as possible; by default.
 
 * **I am using JMicron drive enclosures and some of my drives are not appearing.**
 
     This is likely because JMicron controllers incorrectly report identical serial numbers and other data which confuses various systems.
     |omv| provides an `UDEV rules database <https://github.com/openmediavault/openmediavault/pull/746>`_ which will fix that issue for several USB PATA/SATA bridge controllers.
     If your hardware still does not work, then please provide the information mentioned in that pull request and open a new tracker issue.
 
-    Alternatively you can manually "fix" this by adding a rule to :file:`/lib/udev/rules.d/60-persistent-storage.rules` after the entry for "Fall back usb_id for USB devices"::
+    Alternatively you can manually "fix" this by adding a rule to :file:`/lib/udev/rules.d/60-persistent-storage.rules` after the entry for `Fall back usb_id for USB devices`::
 
         # JMicron drive fix
         KERNEL=="sd*", ENV{ID_VENDOR}=="JMicron", SUBSYSTEMS=="usb", PROGRAM="serial_id %N", ENV{ID_SERIAL}="USB-%c", ENV{ID_SERIAL_SHORT}="%c"