[hawkmoth] [PATCH 1/5] doc: use rst:directive:option for documenting directive options

  • From: Jani Nikula <jani@xxxxxxxxxx>
  • To: hawkmoth@xxxxxxxxxxxxx
  • Date: Wed, 30 Dec 2020 21:42:27 +0200

Use standard syntax for directive documentation.
---
 doc/extension.rst | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/doc/extension.rst b/doc/extension.rst
index 3ac839bf38e4..a404efed2449 100644
--- a/doc/extension.rst
+++ b/doc/extension.rst
@@ -66,11 +66,17 @@ This module provides the following new directive:
    separated list of filename patterns given as arguments. The patterns are
    interpreted relative to the :data:`cautodoc_root` configuration option.
 
-   The ``compat`` option overrides the :data:`cautodoc_compat` configuration
-   option.
+   .. rst:directive:option:: compat
+      :type: text
 
-   The ``clang`` option overrides the :data:`cautodoc_clang` configuration
-   option.
+      The ``compat`` option overrides the :data:`cautodoc_compat` configuration
+      option.
+
+   .. rst:directive:option:: clang
+      :type: text
+
+      The ``clang`` option overrides the :data:`cautodoc_clang` configuration
+      option.
 
 Examples
 --------
-- 
2.29.2


Other related posts: