Fix some docs build warings and errors

Got annoyed looking for the errors messages concerning the docs I was editing. So just fixed them all.
ansibleguy · Jan 20, 2025 · 698d674 · 698d674
1 parent ea48c53
commit 698d674
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 12 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -7,7 +7,7 @@
 author = 'AnsibleGuy'
 extensions = ['piccolo_theme', 'myst_parser']
 templates_path = ['_templates']
-exclude_patterns = []
+exclude_patterns = ['_tmpl/*.rst', '_cp/*.rst']
 html_theme = 'piccolo_theme'
 html_static_path = ['_static']
 html_logo = 'https://files.oxl.at/logos/opnsense.png'

diff --git a/docs/source/modules/interface.rst b/docs/source/modules/interface.rst
@@ -48,7 +48,7 @@ ansibleguy.opnsense.interface_lagg
 This module manages LAGG configuration that can be found in the WEB-UI menu: 'Interfaces - Other Types - LAGG'
 
 ansibleguy.opnsense.interface_loopback
-===================================
+======================================
 
 This module manages Loopback configuration that can be found in the WEB-UI menu: 'Interfaces - Other Types - Loopback'
 

diff --git a/docs/source/modules/ipsec.rst b/docs/source/modules/ipsec.rst
@@ -120,7 +120,7 @@ ansibleguy.opnsense.ipsec_auth_local
     "name","string","true","\-","description, desc","Unique name to identify the entry"
     "connection","string","false for state changes, else true","\-","tunnel, conn, tun","Connection to use this local authentication with"
     "round","integer","false","0","\-","Numeric identifier by which authentication rounds are sorted"
-    "authentication","string","false","psk","auth","One of: 'psk', 'pubkey', 'eap-tls', 'eap-mschapv2', 'xauth-pam', 'eap-radius'; Authentication to perform for this round, when using Pre-Shared key make sure to define one under "VPN->IPsec->Pre-Shared Keys""
+    "authentication","string","false","psk","auth","One of: 'psk', 'pubkey', 'eap-tls', 'eap-mschapv2', 'xauth-pam', 'eap-radius'; Authentication to perform for this round, when using Pre-Shared key make sure to define one under 'VPN->IPsec->Pre-Shared Keys'"
     "id","string","false","\-","ike_id","IKE identity to use for authentication round. When using certificate authentication. The IKE identity must be contained in the certificate, either as the subject DN or as a subjectAltName (the identity will default to the certificate’s subject DN if not specified). Refer to https://docs.strongswan.org/docs/5.9/config/identityParsing.html for details on how identities are parsed and may be configured"
     "eap_id","string","false","\-","\-","Must be defined if authentication is set to one of: ['eap-tls', 'eap-mschapv2', 'eap-radius']; Client EAP-Identity to use in EAP-Identity exchange and the EAP method"
     "certificates","list","false","\-","certs","Certificate or public-key must be defined if authentication is set to 'pubkey'; List of certificate candidates to use for authentication"

diff --git a/docs/source/modules/openvpn.rst b/docs/source/modules/openvpn.rst
@@ -14,7 +14,7 @@ OpenVPN
 `ansibleguy.opnsense.openvpn_client_override <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/openvpn_client_override.yml>`_ |
 `ansibleguy.opnsense.openvpn_status <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/openvpn_status.yml>`_
 
-**API Docs**: `OpenVPN <https://docs.opnsense.org/development/api/core/openvpn.html>`_
+**API Docs**: `Core - OpenVPN <https://docs.opnsense.org/development/api/core/openvpn.html>`_
 
 **Service Docs**: `OpenVPN <https://docs.opnsense.org/troubleshooting/openvpn.html>`_
 

diff --git a/docs/source/modules/route.rst b/docs/source/modules/route.rst
@@ -11,7 +11,7 @@ Routing
 Static Routes
 =============
 
-**TESTS**: `Playbook <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/route.yml>`_
+**TESTS**: `route <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/route.yml>`_
 
 **API Docs**: `Core - Routes <https://docs.opnsense.org/development/api/core/routes.html>`_
 
@@ -20,7 +20,7 @@ Static Routes
 Gateway Groups
 ==============
 
-**TESTS**: `Playbook <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/gateway.yml>`_
+**TESTS**: `gateway <https://github.com/ansibleguy/collection_opnsense/blob/latest/tests/gateway.yml>`_
 
 **API Docs**: `Core - routings <https://docs.opnsense.org/development/api/core/routing.html>`_
 

diff --git a/docs/source/modules/savepoint.rst b/docs/source/modules/savepoint.rst
@@ -2,7 +2,7 @@
 
 .. include:: ../_include/head.rst
 
-.. |rollback_process| image:: ../../_static/img/savepoint_rollback.png
+.. |rollback_process| image:: ../_static/img/savepoint_rollback.png
 
 ==================
 Firewall Savepoint

diff --git a/docs/source/modules/unbound_dnsbl.rst b/docs/source/modules/unbound_dnsbl.rst
@@ -26,13 +26,17 @@ Definition
     :header: "Parameter", "Type", "Required", "Default", "Aliases", "Comment"
     :widths: 15 10 10 10 10 45
 
-    "parameter name","parameter type","if is required","default value","aliases","description"
     "safesearch","boolean","false","false","\-","Force the usage of SafeSearch on Google, DuckDuckGo, Bing, Qwant, PixaBay and YouTube"
     "type","list of strings","false","[]","\-","Select which kind of DNSBL you want to use"
     "whitelists","list of strings","false","[]","whitelist, allowlist, allowlists","List of domains to whitelist. You can use regular expressions"
     "blocklists","list of strings","false","[]","blocklist","List of domains to blocklist. Only exact matches are supported"
     "wildcards","list of strings","false","[]","wildcard","List of wildcard domains to blocklist. All subdomains of the given domain will be blocked. Blocking first-level domains is not supported"
-    "address","strings","false","","\-","Destination ip address for entries in the blocklist (leave empty to use default: 0.0.0.0). Not used when "Return NXDOMAIN" is checked"
+    "address","strings","false","\-","\-","Destination ip address for entries in the blocklist (leave empty to use default: 0.0.0.0). Not used when 'Return NXDOMAIN' is checked"
+
+..  csv-table:: Definition
+    :header: "Parameter", "Type", "Required", "Default", "Aliases", "Comment"
+    :widths: 15 10 10 10 10 45
+
     "nxdomain","bool","false","false","\-","Use the DNS response code NXDOMAIN instead of a destination address"
     "enabled","boolean","false","true","\-","Enable the usage of DNS blocklists"
     "reload","boolean","false","true","\-", .. include:: ../_include/param_reload.rst

diff --git a/docs/source/usage/2_basic.rst b/docs/source/usage/2_basic.rst
@@ -2,7 +2,7 @@
 
 .. include:: ../_include/head.rst
 
-.. |img_ansible_execution_local| image:: ../../_static/img/ansible_execution_local.jpg
+.. |img_ansible_execution_local| image:: ../_static/img/ansible_execution_local.jpg
    :class: wiki-img
 
 

diff --git a/docs/source/usage/4_develop.rst b/docs/source/usage/4_develop.rst
@@ -2,10 +2,10 @@
 
 .. include:: ../_include/head.rst
 
-.. |img_module_abstraction| image:: ../../_static/img/module_abstraction.svg
+.. |img_module_abstraction| image:: ../_static/img/module_abstraction.svg
    :class: wiki-img
 
-.. |img_module_abstraction_actions| image:: ../../_static/img/module_abstraction_actions.svg
+.. |img_module_abstraction_actions| image:: ../_static/img/module_abstraction_actions.svg
    :class: wiki-img
 
 ===========