From 840c11df55d3637115885e8c75f51b89bfbb0cb7 Mon Sep 17 00:00:00 2001 From: Sergei Izmailov Date: Sat, 16 May 2020 04:05:45 +0300 Subject: [PATCH] Fix typo --- doc/plugins/sphinx.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/plugins/sphinx.rst b/doc/plugins/sphinx.rst index 2c8d534b..f43db5a5 100644 --- a/doc/plugins/sphinx.rst +++ b/doc/plugins/sphinx.rst @@ -80,7 +80,7 @@ symbols to a file to be linked from elsewhere, see PLUGINS += ['m.sphinx'] M_SPHINX_INVENTORIES = [...] M_SPHINX_INVENTORY_OUTPUT = 'objects.inv' - M_SPHIMX_PARSE_DOCSTRINGS = False + M_SPHINX_PARSE_DOCSTRINGS = False `Links to external Sphinx documentation`_ ========================================= @@ -511,7 +511,7 @@ By default, docstrings are `treated by the Python doc generator as plain text <{ and only externally-supplied docs are parsed. This is done because, for example in Python standard library, embedded docstrings are often very terse without any markup and full docs are external. If you want the docstrings to be parsed, -enable the :py:`M_SPHIMX_PARSE_DOCSTRINGS` option. Compared to the directives +enable the :py:`M_SPHINX_PARSE_DOCSTRINGS` option. Compared to the directives above, there's only one difference --- instead of a :rst:`:summary:` option, the first paragraph is taken as a summary, the second paragraph as the option list (if it contains option fields) and the rest as documentation content. -- 2.30.2