Merge pull request #52 from oreillymedia/bug_fix_multi_top_level_sub_chapters

Bug fix multi top level sub chapters

Author: delfanbaum

README.md

@@ -74,6 +74,11 @@ Options:
 
 ## Release Notes
 
+### 1.1.1
+
+Bug fix:
+- Don't drop additional top-level headings in subchapter files
+
 ### 1.1.0
 
 Features:

jupyter_book_to_htmlbook/file_processing.py

@@ -135,22 +135,66 @@ def apply_datatype(chapter, ch_name):
     return chapter
 
 
+def get_top_level_sections(soup):
+    """
+    Helper utility to grab top-level sections in main <article>. Returns
+    all but bibliography sections
+    """
+    section_wrappers = soup.find_all("article", attrs={"role": "main"})
+
+    # test case for partial files, not expected in production
+    if len(section_wrappers) == 0:
+        sections = soup.find_all('section')
+    elif len(section_wrappers) != 1:
+        article = soup.find('article', attrs={"role": "main"})
+        try:
+            main_title = article.find('h1').get_text()
+        except AttributeError:
+            main_title = soup.find("h1")
+        print("Warning: " +
+              f"The chapter with title '{main_title}' is malformed.")
+        return None, None
+    else:
+        main = section_wrappers[0]
+        sections = []
+
+        for element in main.children:
+            if (
+                    element.name == "section" and
+                    element.get('id') != "bibliography"
+               ):
+                sections.append(element)
+
+    return sections
+
+
 def get_main_section(soup):
     """
     Gets the main "section," or the main chapter text, and additionally
     checks to see if there is a separate bibliography section, returning
     that if it exists to be dealt with later.
     """
-    sections = soup.find_all('section')
+    sections = get_top_level_sections(soup)
+
     try:
         main = sections[0]
-    except IndexError:  # does not have a section class for top-level
-        logging.warning("Looks like {toc_element.name} is malformed.")
-        return None, None
+    except IndexError:
+        main = None
+
     if len(sections) > 1:
-        bibliography = soup.find('section', id="bibliography")
-    else:
-        bibliography = None
+        article = soup.find('article', attrs={"role": "main"})
+        try:
+            main_title = article.find('h1').get_text()
+        except AttributeError:
+            main_title = soup.find("h1")
+        err_msg = f"The chapter with title '{main_title}' " + \
+                  "has extra <section>s " + \
+                  "that will not be processed. Please check the " + \
+                  "notebook source files."
+        logging.warning(err_msg)
+        print(err_msg)
+    bibliography = soup.find('section', id="bibliography")
+
     return main, bibliography
 
 
@@ -172,11 +216,14 @@ def process_chapter_soup(
 
     # perform initial swapping and namespace designation
     chapter, bib = get_main_section(base_soup)
+    if bib and not chapter:  # bibs can be their own chapters
+        chapter = bib
+        bib = None
 
     if not chapter:  # guard against malformed files
         logging.warning(f"Failed to process {toc_element}.")
         raise RuntimeError(
-            f"Failed to process {toc_element}. Please check for error in " +
+            f"Failed to process {toc_element}. Please check for errors in " +
             "your source file(s). Contact the Tools team for additional " +
             "support.")
 
@@ -189,8 +236,10 @@ def process_chapter_soup(
 
         if chapter_parts:
             for subfile in chapter_parts:
-                subsection, sub_bib = process_chapter_subparts(subfile)
-                chapter.append(subsection)
+                subsections, sub_bib = process_chapter_subparts(subfile)
+                if subsections:
+                    for subsection in subsections:
+                        chapter.append(subsection)
                 if bib and sub_bib:
                     entries = sub_bib.find_all("dd")  # type: ignore
                     bib.dl.extend(entries)  # type: ignore
@@ -211,19 +260,24 @@ def process_chapter_subparts(subfile):
     """ processing for chapters with "sections" """
     with open(subfile, 'r') as f:
         soup = BeautifulSoup(f, 'lxml')
-        section, bib = get_main_section(soup)
-        section['data-type'] = 'sect1'  # type: ignore
-        del section['class']  # type: ignore
-        # move id from empty span to section
-        try:
-            section['id'] = section.select_one('span')['id']  # type: ignore
-        except TypeError:
-            # fun fact, this happens when there's not numbering on the toc
-            pass  # like before, if it's not there that's OK.
-        except KeyError:
-            # fun fact, this happens when there is numbering on the toc
-            pass  # like before, if it's not there that's OK.
-    return section, bib
+        top_level_sections = get_top_level_sections(soup)
+
+        for section in top_level_sections:
+            section['data-type'] = 'sect1'  # type: ignore
+            del section['class']  # type: ignore
+            # move id from empty span to section
+            try:
+                section['id'] = section.select_one(  # type: ignore
+                                    'span')['id']
+            except TypeError:
+                # this happens when there's not numbering on the toc
+                pass  # like before, if it's not there that's OK.
+            except KeyError:
+                # fun fact, this happens when there is numbering on the toc
+                pass  # like before, if it's not there that's OK.
+        bibliography = soup.find('section', id="bibliography")
+
+    return top_level_sections, bibliography
 
 
 def process_chapter(toc_element,

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "jupyter-book-to-htmlbook"
-version = "1.1.0"
+version = "1.1.1"
 description = "A script to convert jupyter book html files to htmlbook for consumption in Atlas"
 authors = ["delfanbaum"]
 

tests/example_book/_build/html/bibliography.html

@@ -163,6 +163,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="notebooks/code_py.html">Code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/code_r.html">This Is a Title</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Edge Cases</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="notebooks/many_a_levels.html">My Main Title</a></li>
+
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">References</span></p>
 <ul class="current nav bd-sidenav">

tests/example_book/_build/html/notebooks/ch01.html

@@ -164,6 +164,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="code_py.html">Code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="code_r.html">This Is a Title</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Edge Cases</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="many_a_levels.html">My Main Title</a></li>
+
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">References</span></p>
 <ul class="nav bd-sidenav">

tests/example_book/_build/html/notebooks/ch02.00.html

@@ -164,6 +164,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="code_py.html">Code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="code_r.html">This Is a Title</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Edge Cases</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="many_a_levels.html">My Main Title</a></li>
+
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">References</span></p>
 <ul class="nav bd-sidenav">

tests/example_book/_build/html/notebooks/ch02.01.html

@@ -164,6 +164,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="code_py.html">Code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="code_r.html">This Is a Title</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Edge Cases</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="many_a_levels.html">My Main Title</a></li>
+
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">References</span></p>
 <ul class="nav bd-sidenav">

tests/example_book/_build/html/notebooks/ch02.02.html

@@ -164,6 +164,11 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="code_py.html">Code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="code_r.html">This Is a Title</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Edge Cases</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="many_a_levels.html">My Main Title</a></li>
+
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">References</span></p>
 <ul class="nav bd-sidenav">

tests/example_book/_build/html/notebooks/code_py.html

@@ -164,6 +164,11 @@
 <ul class="current nav bd-sidenav">
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">Code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="code_r.html">This Is a Title</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Edge Cases</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="many_a_levels.html">My Main Title</a></li>
+
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">References</span></p>
 <ul class="nav bd-sidenav">

tests/example_book/_build/html/notebooks/code_r.html

@@ -64,7 +64,7 @@
     <script>DOCUMENTATION_OPTIONS.pagename = 'notebooks/code_r';</script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Markup Tests" href="markup.html" />
+    <link rel="next" title="My Main Title" href="many_a_levels.html" />
     <link rel="prev" title="Code" href="code_py.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
@@ -164,6 +164,11 @@
 <ul class="current nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="code_py.html">Code</a></li>
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">This Is a Title</a></li>
+</ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Edge Cases</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="many_a_levels.html">My Main Title</a></li>
+
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">References</span></p>
 <ul class="nav bd-sidenav">
@@ -449,11 +454,11 @@ <h1>This Is a Title<a class="headerlink" href="#this-is-a-title" title="Permalin
       </div>
     </a>
     <a class="right-next"
-       href="markup.html"
+       href="many_a_levels.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
-        <p class="prev-next-title">Markup Tests</p>
+        <p class="prev-next-title">My Main Title</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>