[hawkmoth] [PATCH 2/5] doc: add types to extension configuration options

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

Document the type expectation.
---
 doc/extension.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/extension.rst b/doc/extension.rst
index a404efed2449..9d5b8b3ad13f 100644
--- a/doc/extension.rst
+++ b/doc/extension.rst
@@ -25,6 +25,7 @@ Configuration
 The extension has a few configuration options that can be set in ``conf.py``:
 
 .. py:data:: cautodoc_root
+   :type: str
 
    Path to the root of the source files. Defaults to the
    :term:`sphinx:configuration directory`, i.e. the directory containing
@@ -39,6 +40,7 @@ The extension has a few configuration options that can be set 
in ``conf.py``:
       cautodoc_root = os.path.abspath('my/sources/dir')
 
 .. py:data:: cautodoc_compat
+   :type: str
 
    Compatibility option. One of ``none`` (default), ``javadoc-basic``,
    ``javadoc-liberal``, and ``kernel-doc``. This can be used to perform a
@@ -50,6 +52,7 @@ The extension has a few configuration options that can be set 
in ``conf.py``:
       are likely to change.
 
 .. py:data:: cautodoc_clang
+   :type: str
 
    A comma separated list of arguments to pass to ``clang`` while parsing the
    source, typically to define macros for conditional compilation, for example
-- 
2.29.2


Other related posts:

  • » [hawkmoth] [PATCH 2/5] doc: add types to extension configuration options - Jani Nikula