Merge pull request #1104 from bjones1/num_fix

Fix: Only restart question numbers on numbered sections.

Author: bnmnetp

runestone/common/question_number.py

@@ -19,28 +19,30 @@
 def _insert_qnum(app, doctree, docname):
     toc = app.env.toc_secnumbers.get(docname, {})
 
-    def get_secnum_tuple(section_ref, current_secnum_tuple_):
+    # Return the section number tuple for the given ``section_ref`` if it exists, or None if not.
+    def get_secnum_tuple(section_ref):
         # The Sphinx TOC structure is::
         #
         #   Dict[docname: str,
         #       Dict[ref: str, secnum_tuple: Tuple[int, ...]
         #   ]
         #
         # where a ``ref`` of ``''`` provides a tuple for the document as a whole.
-        #
-        # Not all section references will have an associated number. Return the current section if it was numbered and not None; otherwise, current the existing section number.
-        return toc.get(section_ref, current_secnum_tuple_) or current_secnum_tuple_
 
-    # Set the current section number to the section for the overall document, if it's available.
-    current_secnum_tuple = get_secnum_tuple("", tuple())
+        return toc.get(section_ref)
+
+    # Set the current section number to the section for the overall document, if it's available; otherwise, use no number (an empty tuple).
+    current_secnum_tuple = get_secnum_tuple("") or tuple()
 
     current_question_number = 1
     for node in doctree.traverse():
         if isinstance(node, nodes.section):
             # To create a reference for a section node, I used this string, which was taken from ``sphinx.environment.collectors.toctree.TocTreeCollector.process_doc.build_toc``.
-            current_secnum_tuple = get_secnum_tuple('#' + node['ids'][0], current_secnum_tuple)
-            # Question numbering restarts at the beginning of each section.
-            current_question_number = 1
+            new_secnum_tuple = get_secnum_tuple('#' + node['ids'][0])
+            # Question numbering restarts at the beginning of each numbered section; otherwise, continue to existing numbering through unnumbered sections.
+            if new_secnum_tuple:
+                current_secnum_tuple = new_secnum_tuple
+                current_question_number = 1
         elif isinstance(node, RunestoneIdNode):
             question_number_tuple = current_secnum_tuple + (current_question_number, )
             question_number_str = ".".join(map(str, question_number_tuple))