diff options
Diffstat (limited to 'doc/config.rst')
| -rw-r--r-- | doc/config.rst | 45 |
1 files changed, 26 insertions, 19 deletions
diff --git a/doc/config.rst b/doc/config.rst index 162ed914..cc6f7c33 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -57,11 +57,6 @@ General configuration The configuration file itself can be an extension; for that, you only need to provide a :func:`setup` function in it. -.. confval:: templates_path - - A list of paths that contain extra templates (or templates that overwrite - builtin templates). - .. confval:: source_suffix The file name extension of source files. Only files with this suffix will be @@ -113,22 +108,12 @@ General configuration toctree. Use this setting to suppress the warning that is normally emitted in that case. -.. confval:: add_function_parentheses +.. confval:: exclude_dirs - A boolean that decides whether parentheses are appended to function and - method role text (e.g. the content of ``:func:`input```) to signify that the - name is callable. Default is ``True``. + A list of directory names, relative to the source directory, that are to be + excluded from the search for source files. -.. confval:: add_module_names - - A boolean that decides whether module names are prepended to all - :term:`description unit` titles, e.g. for :dir:`function` directives. - Default is ``True``. - -.. confval:: show_authors - - A boolean that decides whether :dir:`moduleauthor` and :dir:`sectionauthor` - directives produce any output in the built files. + .. versionadded:: 0.2.1 .. confval:: pygments_style @@ -140,6 +125,11 @@ General configuration If the value is a fully-qualified name of a custom Pygments style class, this is then used as custom style. +.. confval:: templates_path + + A list of paths that contain extra templates (or templates that overwrite + builtin templates). + .. confval:: template_bridge A string with the fully-qualified name of a callable (or simply a class) that @@ -147,6 +137,23 @@ General configuration instance is then used to render HTML documents, and possibly the output of other builders (currently the changes builder). +.. confval:: add_function_parentheses + + A boolean that decides whether parentheses are appended to function and + method role text (e.g. the content of ``:func:`input```) to signify that the + name is callable. Default is ``True``. + +.. confval:: add_module_names + + A boolean that decides whether module names are prepended to all + :term:`description unit` titles, e.g. for :dir:`function` directives. + Default is ``True``. + +.. confval:: show_authors + + A boolean that decides whether :dir:`moduleauthor` and :dir:`sectionauthor` + directives produce any output in the built files. + .. _html-options: |