docs: better docs, mv doxygen to sphinx

[vpp.git] / docs / _scripts / siphon_templates / markdown / clicmd / item_format.md

diff --git a/doxygen/siphon_templates/markdown/clicmd/item_format.md b/docs/_scripts/siphon_templates/markdown/clicmd/item_format.md
similarity index 66%
rename from doxygen/siphon_templates/markdown/clicmd/item_format.md
rename to docs/_scripts/siphon_templates/markdown/clicmd/item_format.md
index 288dae4..f1caa96 100644 (file)
--- a/doxygen/siphon_templates/markdown/clicmd/item_format.md
+++ b/docs/_scripts/siphon_templates/markdown/clicmd/item_format.md
@@ -14,30 +14,36 @@
 # limitations under the License.
 #}
 {% set v = item['value'] %}
-{{ "@section %s %s" % (meta['label'], v['path']) }}
 {% if 'short_help' in v %}
-
-### Summary/usage
-
 {% set str = v['short_help'] %}
-{% set period = "." if str[-1] != "." else "" %}
-{% set prefix = "    " if "[" in str or "<" in str or "|" in str else "" %}
 {% set str = this.unescape(str) %}
-{{ "%s%s%s" % (prefix, str, period) }}
+
+{# Summary/usage #}
+{{ item['value']['path'] }}
+-------------------------------------------------------------------------
+
+.. code-block:: console
+
+    {{ this.reindent(str, 4) }}
+
 {% endif %}
 {% if 'long_help' in v %}
+{% set long_help = v['long_help'] %}
+{% set long_help = this.unescape(long_help) %}
 {# This is seldom used and will likely be deprecated #}
+{# Long help #}
+.. code-block:: console
 
-### Long help
+    {{ this.reindent(long_help, 4) }}
 
-{{ v['long_help'] }}
 {% endif %}
 {% if 'siphon_block' in item['meta'] %}
 {% set sb = item["meta"]["siphon_block"] %}
+{% set sb = this.process_special(sb) %}
 {% if sb %}
 {# Extracted from the code in /*? ... ?*/ blocks #}
 
-### Description
+{# Description #}
 
 {{ sb }}
 {% endif %}
@@ -45,15 +51,12 @@
 {% if 'name' in meta or 'function' in v %}
 {# Gives some developer-useful linking #}
 
-### Declaration and implementation
 {% if "name" in meta %}
-
-{{ "Declaration: @ref %s (@ref %s line %d)" %
-   (meta['name'], meta["file"], item["meta"]["line_start"]) }}
+Declaration: ``{{ meta['name'] }}`` `{{ meta["file"] }} line {{ item["meta"]["line_start"] }} <{{ this.repository_link }}{{ meta["file"] }}#L{{ item["meta"]["line_start"] }}>`_
 {% endif %}
 {% if "function" in v %}
 
-{{ "Implementation: @ref %s." % v["function"] }}
+Implementation: ``{{ v["function"] }}``
 {% endif %}
 {% endif %}