From: Vladimír Vondruš <mosra@centrum.cz>
Date: Tue, 7 May 2019 22:28:24 +0000 (+0200)
Subject: documentation/python: module tree showed expanders where not needed.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=8d73e658fd9bd8162e5fc3f495e1ebf55553431b;p=blog.git

documentation/python: module tree showed expanders where not needed.

What the heck was I doing there.
---

diff --git a/documentation/python.py b/documentation/python.py
index 97714ecd..3fea6eca 100755
--- a/documentation/python.py
+++ b/documentation/python.py
@@ -999,12 +999,12 @@ def run(basedir, config, templates):
     # Recurse into the tree and mark every node that has nested modules with
     # has_nestaable_children.
     def mark_nested_modules(list: List[IndexEntry]):
-        has_nestaable_children = False
+        has_nestable_children = False
         for i in list:
             if i.kind != 'module': continue
-            has_nestaable_children = True
-            mark_nested_modules(i.children)
-        return has_nestaable_children
+            has_nestable_children = True
+            i.has_nestable_children = mark_nested_modules(i.children)
+        return has_nestable_children
     mark_nested_modules(state.class_index)
 
     # Create module and class index
diff --git a/documentation/templates/python/modules.html b/documentation/templates/python/modules.html
index 0e8f614f..8264d2fc 100644
--- a/documentation/templates/python/modules.html
+++ b/documentation/templates/python/modules.html
@@ -5,7 +5,7 @@
         <h1>Modules</h2>
         <ul class="m-doc">
           {% for i in index.classes|selectattr('kind', 'equalto', 'module') recursive %}
-          {% if i.children %}
+          {% if i.has_nestable_children %}
           <li class="m-doc-collapsible">
             <a href="#" onclick="return toggle(this)">{{ i.kind }}</a> <a href="{{ i.url }}" class="m-doc">{{ i.name }}</a> <span class="m-doc">{{ i.summary }}</span>
             <ul class="m-doc">
diff --git a/documentation/test_python/inspect_string/classes.html b/documentation/test_python/inspect_string/classes.html
index e7366474..1b28b235 100644
--- a/documentation/test_python/inspect_string/classes.html
+++ b/documentation/test_python/inspect_string/classes.html
@@ -37,7 +37,12 @@
             <a href="#" onclick="return toggle(this)">module</a> <a href="inspect_string.html" class="m-doc">inspect_string</a> <span class="m-doc">A module</span>
             <ul class="m-doc">
               <li>module <a href="inspect_string.another_module.html" class="m-doc">another_module</a> <span class="m-doc">Another module</span></li>
-              <li>module <a href="inspect_string.subpackage.html" class="m-doc">subpackage</a> <span class="m-doc">A subpackage</span></li>
+              <li class="m-doc-collapsible collapsed">
+                <a href="#" onclick="return toggle(this)">module</a> <a href="inspect_string.subpackage.html" class="m-doc">subpackage</a> <span class="m-doc">A subpackage</span>
+                <ul class="m-doc">
+                  <li>class <a href="inspect_string.subpackage.Foo.html" class="m-doc">Foo</a> <span class="m-doc">A class in a subpackage. Shouldn&#x27;t cause the module tree to have an expander for it.</span></li>
+                </ul>
+              </li>
               <li class="m-doc-collapsible collapsed">
                 <a href="#" onclick="return toggle(this)">class</a> <a href="inspect_string.Foo.html" class="m-doc">Foo</a> <span class="m-doc">The foo class</span>
                 <ul class="m-doc">
diff --git a/documentation/test_python/inspect_string/inspect_string/subpackage/__init__.py b/documentation/test_python/inspect_string/inspect_string/subpackage/__init__.py
index 1fc06e45..8e6580f9 100644
--- a/documentation/test_python/inspect_string/inspect_string/subpackage/__init__.py
+++ b/documentation/test_python/inspect_string/inspect_string/subpackage/__init__.py
@@ -1 +1,4 @@
 """A subpackage"""
+
+class Foo:
+    """A class in a subpackage. Shouldn't cause the module tree to have an expander for it."""