Generate Modules documentation section

moisseev · Apr 11, 2024 · 28baa82 · 28baa82
1 parent 60ce9f0
commit 28baa82
Show file tree

Hide file tree

Showing 32 changed files with 35 additions and 79 deletions.
diff --git a/_layouts/doc.html b/_layouts/doc.html
@@ -107,54 +107,10 @@
 				</ul>
 			</li>
 
-			<li class="r-docs-subnav list-group-item">
-				<a href="{{ site.baseurl }}/doc/modules/">Modules documentation</a>
-				<ul>
-					<li><a href="{{ site.baseurl }}/doc/modules/antivirus.html"><strong>Antivirus</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/arc.html">ARC module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/asn.html">ASN module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/bayes_expiry.html">Bayes expiry module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/clickhouse.html"><strong>Clickhouse module</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/chartable.html">Chartable</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/dcc.html">DCC module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/dkim.html">DKIM</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/dkim_signing.html">DKIM signing</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/dmarc.html">DMARC</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/elastic.html">Elasticsearch exporter</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/emails.html">Emails scan</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/external_relay.html">External relay</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/external_services.html"><strong>External services</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/force_actions.html"><strong>Force Actions</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/fuzzy_check.html">Fuzzy check</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/greylisting.html">Greylisting module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/hfilter.html">Hfilter</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/history_redis.html">History redis module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/known_senders.html">Known senders module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/maillist.html">Mailing list</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/metadata_exporter.html">Metadata exporter</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/metric_exporter.html">Metric exporter</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/mid.html">MID module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/milter_headers.html"><strong>Milter headers</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/mime_types.html">Mime types</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/multimap.html"><strong>Multimap</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/mx_check.html">MX Check</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/neural.html">Neural network module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/phishing.html">Phishing check</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/ratelimit.html"><strong>Ratelimit</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/rbl.html"><strong>RBL</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/regexp.html"><strong>Regexp</strong></a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/reputation.html">Reputation</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/once_received.html">Received policy</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/replies.html">Replies module</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/rspamd_update.html">Rspamd update</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/spamassassin.html">Spamassassin rules</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/spamtrap.html">Spamtrap</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/spf.html">SPF</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/trie.html">Trie matcher</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/url_redirector.html">URL redirector</a></li>
-					<li><a href="{{ site.baseurl }}/doc/modules/whitelist.html">Whitelist</a></li>
-				</ul>
-			</li>
+			{% include directory-tree.html
+				dir="/doc/modules"
+				strong=true
+				dir_class="r-docs-subnav list-group-item" %}
 
 			<li class="r-docs-subnav list-group-item">
 				<a href="{{ site.baseurl }}/doc/workers/">Workers documentation</a>

diff --git a/doc/modules/antivirus.md b/doc/modules/antivirus.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Antivirus module
+title: Antivirus
 strong: true
 ---
 

diff --git a/doc/modules/chartable.md b/doc/modules/chartable.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Chartable module
+title: Chartable
 ---
 # Chartable module
 

diff --git a/doc/modules/dkim.md b/doc/modules/dkim.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: DKIM module
+title: DKIM
 ---
 # DKIM module
 

diff --git a/doc/modules/dkim_signing.md b/doc/modules/dkim_signing.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: DKIM signing module
+title: DKIM signing
 ---
 
 # DKIM signing module

diff --git a/doc/modules/dmarc.md b/doc/modules/dmarc.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: DMARC module
+title: DMARC
 ---
 # DMARC module
 

diff --git a/doc/modules/elastic.md b/doc/modules/elastic.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Elasticsearch module
+title: Elasticsearch exporter
 ---
 
 # Elasticsearch module

diff --git a/doc/modules/emails.md b/doc/modules/emails.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Emails module
+title: Emails scan
 ---
 
 # Emails module

diff --git a/doc/modules/external_relay.md b/doc/modules/external_relay.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: External Relay module
+title: External relay
 ---
 
 # External Relay module

diff --git a/doc/modules/force_actions.md b/doc/modules/force_actions.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Force Actions module
+title: Force Actions
 strong: true
 ---
 

diff --git a/doc/modules/fuzzy_check.md b/doc/modules/fuzzy_check.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Fuzzy check module
+title: Fuzzy check
 ---
 # Fuzzy check module
 

diff --git a/doc/modules/hfilter.md b/doc/modules/hfilter.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Hfilter module
+title: Hfilter
 ---
 
 # Hfilter module

diff --git a/doc/modules/history_redis.md b/doc/modules/history_redis.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Redis history module
+title: History redis module
 ---
 
 # Redis history module

diff --git a/doc/modules/known_senders.md b/doc/modules/known_senders.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: known_senders module
+title: Known senders module
 ---
 # Rspamd `known_senders` Plugin Documentation
 

diff --git a/doc/modules/maillist.md b/doc/modules/maillist.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Mailing lists module
+title: Mailing list
 ---
 # Mail list module
 

diff --git a/doc/modules/milter_headers.md b/doc/modules/milter_headers.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Milter headers module
+title: Milter headers
 strong: true
 ---
 

diff --git a/doc/modules/mime_types.md b/doc/modules/mime_types.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Mime types modules
+title: Mime types
 ---
 
 # Rspamd mime types module

diff --git a/doc/modules/multimap.md b/doc/modules/multimap.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Multimap module
+title: Multimap
 strong: true
 ---
 # Multimap module

diff --git a/doc/modules/mx_check.md b/doc/modules/mx_check.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: MX Check module
+title: MX Check
 ---
 
 # MX Check module

diff --git a/doc/modules/once_received.md b/doc/modules/once_received.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Once received module
+title: Received policy
 ---
 # Once received module
 

diff --git a/doc/modules/phishing.md b/doc/modules/phishing.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Phishing module
+title: Phishing check
 ---
 # Phishing module
 

diff --git a/doc/modules/ratelimit.md b/doc/modules/ratelimit.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Ratelimit module
+title: Ratelimit
 strong: true
 ---
 

diff --git a/doc/modules/rbl.md b/doc/modules/rbl.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: RBL module
+title: RBL
 strong: true
 ---
 # RBL module

diff --git a/doc/modules/regexp.md b/doc/modules/regexp.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Regexp module
+title: Regexp
 strong: true
 ---
 

diff --git a/doc/modules/reputation.md b/doc/modules/reputation.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Reputation module
+title: Reputation
 ---
 
 # Reputation plugin

diff --git a/doc/modules/rspamd_update.md b/doc/modules/rspamd_update.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Rspamd updates module
+title: Rspamd update
 ---
 # Rspamd update module
 

diff --git a/doc/modules/spamassassin.md b/doc/modules/spamassassin.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Spamassassin module
+title: Spamassassin rules
 ---
 # Spamassassin rules module
 

diff --git a/doc/modules/spamtrap.md b/doc/modules/spamtrap.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Spamtrap module
+title: Spamtrap
 ---
 # Spamtrap module
 

diff --git a/doc/modules/spf.md b/doc/modules/spf.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: SPF module
+title: SPF
 ---
 # SPF module
 

diff --git a/doc/modules/trie.md b/doc/modules/trie.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Trie module
+title: Trie matcher
 ---
 
 # Trie plugin

diff --git a/doc/modules/url_redirector.md b/doc/modules/url_redirector.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: URL redirector module
+title: URL redirector
 ---
 
 # URL redirector module

diff --git a/doc/modules/whitelist.md b/doc/modules/whitelist.md
@@ -1,6 +1,6 @@
 ---
 layout: doc
-title: Whitelist module
+title: Whitelist
 ---
 
 # Whitelist module