From cf05aa309b56325575ed462c4065ac06540edd68 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 18 Jul 2019 20:57:23 +0200 Subject: [PATCH] Doc++ --- doc/documentation/python.rst | 6 +++--- doc/plugins/sphinx.rst | 11 ++++++++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/doc/documentation/python.rst b/doc/documentation/python.rst index 3a213c8a..276fb8ad 100644 --- a/doc/documentation/python.rst +++ b/doc/documentation/python.rst @@ -790,9 +790,9 @@ enum class itself, not the values. .. note-info:: - pybind 2.3 (not released yet) is scheduled to support docstrings for enum - values (see :gh:`pybind/pybind11#1160`). Support for this feature is not - done on the script side yet. + pybind 2.3 supports docstrings for enum values (see + :gh:`pybind/pybind11#1160`). Support for this feature is not done on the + script side yet. `Command-line options`_ ======================= diff --git a/doc/plugins/sphinx.rst b/doc/plugins/sphinx.rst index f1f62d1e..7dd5c16a 100644 --- a/doc/plugins/sphinx.rst +++ b/doc/plugins/sphinx.rst @@ -48,8 +48,8 @@ using external files in a way similar to `Sphinx `_ `How to use`_ ============= -`Pelican`_ ----------- +`Python doc theme`_ +------------------- List the plugin in your :py:`PLUGINS`. @@ -57,6 +57,11 @@ List the plugin in your :py:`PLUGINS`. PLUGINS += ['m.sphinx'] +.. note-info:: + + This plugin is available only for the `Python doc theme <{filename}/documentation/python.rst>`_, + not usable for Pelican or Doxygen themes. + `Module, class, enum, function, property and data docs`_ ======================================================== @@ -94,7 +99,7 @@ formatting simpler (for display inside IDEs or via the builtin :py:`help()`), while supplying an alternative and more complex-formatted summary for the actual rendered docs. -.. note-info:: +.. note-warning:: Modules, classes and data described using these directives have to actually exist (i.e., accessible via inspection) in given module. If given name -- 2.30.2