documentation/python: test external summary for a submodule.

Fails. It's amazing how far can some bugs go unnoticed.

diff --git a/documentation/test_python/content/classes.html b/documentation/test_python/content/classes.html
index 293619c330c95efd392a068c3aed6a68177218a8..bf4f72230e8ba966e0ae7488f81979fd39089122 100644 (file)
--- a/documentation/test_python/content/classes.html
+++ b/documentation/test_python/content/classes.html
@@ -25,6 +25,7 @@
             <a href="#" onclick="return toggle(this)">module</a> <a href="content.html" class="m-doc">content</a> <span class="m-doc">This overwrites the docstring for <code>content</code>.</span>
             <ul class="m-doc">
               <li>module <a href="content.docstring_summary.html" class="m-doc">docstring_summary</a> <span class="m-doc">This module retains summary from the docstring</span></li>
+              <li>module <a href="content.submodule.html" class="m-doc">submodule</a> <span class="m-doc">This submodule has an external summary.</span></li>
               <li>class <a href="content.Class.html" class="m-doc">Class</a> <span class="m-doc">This overwrites the docstring for <code>content.Class</code>.</span></li>
               <li>class <a href="content.ClassWithSummary.html" class="m-doc">ClassWithSummary</a> <span class="m-doc">This class has summary from the docstring</span></li>
             </ul>

diff --git a/documentation/test_python/content/content.html b/documentation/test_python/content/content.html
index 9e0c0c924aeef4e2adbaf06bae1f27bc17cbe5b3..3fb124db47fbc8c648390232e03c83cd682b9fd7 100644 (file)
--- a/documentation/test_python/content/content.html
+++ b/documentation/test_python/content/content.html
@@ -45,6 +45,8 @@ tho.</p>
           <dl class="m-doc">
             <dt>module <a href="content.docstring_summary.html" class="m-doc">docstring_summary</a></dt>
             <dd>This module retains summary from the docstring</dd>
+            <dt>module <a href="content.submodule.html" class="m-doc">submodule</a></dt>
+            <dd>This submodule has an external summary.</dd>
           </dl>
         </section>
         <section id="classes">

diff --git a/documentation/test_python/content/content/__init__.py b/documentation/test_python/content/content/__init__.py
index 339c08c0d7331e7ac6df9cebee84b0f2e8aae5bb..9850d0b722146b4a6997e06822b01895ea90d6ce 100644 (file)
--- a/documentation/test_python/content/content/__init__.py
+++ b/documentation/test_python/content/content/__init__.py
@@ -1,7 +1,7 @@
 """Yes so this is module summary, not shown in the output"""
 
 import enum
-from . import docstring_summary
+from . import docstring_summary, submodule
 
 class Class:
     """And this class summary, not shown either"""

diff --git a/documentation/test_python/content/content/submodule.py b/documentation/test_python/content/content/submodule.py
new file mode 100644 (file)
index 0000000..54e2071
--- /dev/null
+++ b/documentation/test_python/content/content/submodule.py
@@ -0,0 +1 @@
+# This module has an external summary

diff --git a/documentation/test_python/content/docs.rst b/documentation/test_python/content/docs.rst
index 2cac109dbd89e164213029f01b74ee6cebecec62..76d3d884f298f8b929acfb01e62e3a969972850a 100644 (file)
--- a/documentation/test_python/content/docs.rst
+++ b/documentation/test_python/content/docs.rst
@@ -13,6 +13,9 @@
 
     And adds detailed docs.
 
+.. py:module:: content.submodule
+    :summary: This submodule has an external summary.
+
 .. py:class:: content.Class
     :summary: This overwrites the docstring for ``content.Class``.