chiark / gitweb /
Doc++
authorVladimír Vondruš <mosra@centrum.cz>
Thu, 18 Jul 2019 18:57:23 +0000 (20:57 +0200)
committerVladimír Vondruš <mosra@centrum.cz>
Thu, 18 Jul 2019 18:57:37 +0000 (20:57 +0200)
doc/documentation/python.rst
doc/plugins/sphinx.rst

index 3a213c8a3a4f631b11560be0abf1a8f1d792c678..276fb8ad190d603f2575631297026c4fcb165b21 100644 (file)
@@ -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`_
 =======================
index f1f62d1ec1606bb67e3e89f04d4617e2868ad8c5..7dd5c16afcb1a689cd2467911a2da1f697eda45e 100644 (file)
@@ -48,8 +48,8 @@ using external files in a way similar to `Sphinx <https://www.sphinx-doc.org/>`_
 `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