diff --git a/jupyter_book_to_htmlbook/file_processing.py b/jupyter_book_to_htmlbook/file_processing.py index c755db0..9ff1c4e 100644 --- a/jupyter_book_to_htmlbook/file_processing.py +++ b/jupyter_book_to_htmlbook/file_processing.py @@ -232,7 +232,7 @@ def process_chapter_soup( else: chapter['xmlns'] = 'http://www.w3.org/1999/xhtml' # type: ignore - del chapter['class'] + del chapter['class'] # type: ignore # promote subheadings within "base" chapter chapter = promote_headings(chapter) @@ -242,10 +242,12 @@ def process_chapter_soup( subsections, sub_bib = process_chapter_subparts(subfile) if subsections: for subsection in subsections: - chapter.append(subsection) + chapter.append(subsection) # type: ignore if bib and sub_bib: entries = sub_bib.find_all("dd") # type: ignore bib.dl.extend(entries) # type: ignore + # throw away the sub-bib section + _ = sub_bib.extract() elif sub_bib: bib = sub_bib @@ -328,7 +330,7 @@ def process_chapter(toc_element, chapter, ids = process_ids(chapter, book_ids) # write the file, preserving any directory structure(s) from source - if type(toc_element) == list: + if type(toc_element) is list: dir_structure = [p for p in toc_element[0].parts if p not in source_dir.parts] else: diff --git a/poetry.lock b/poetry.lock index 6e1d1f4..a11dc9b 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2581,6 +2581,18 @@ pure-eval = "*" [package.extras] tests = ["cython", "littleutils", "pygments", "pytest", "typeguard"] +[[package]] +name = "standard-imghdr" +version = "3.13.0" +description = "Standard library imghdr redistribution. \"dead battery\"." +optional = false +python-versions = "*" +groups = ["main"] +files = [ + {file = "standard_imghdr-3.13.0-py3-none-any.whl", hash = "sha256:30a1bff5465605bb496f842a6ac3cc1f2131bf3025b0da28d4877d6d4b7cc8e9"}, + {file = "standard_imghdr-3.13.0.tar.gz", hash = "sha256:8d9c68058d882f6fc3542a8d39ef9ff94d2187dc90bd0c851e0902776b7b7a42"}, +] + [[package]] name = "tabulate" version = "0.9.0" @@ -2698,6 +2710,33 @@ dev = ["autoflake (>=1.3.1,<2.0.0)", "flake8 (>=3.8.3,<4.0.0)", "pre-commit (>=2 doc = ["cairosvg (>=2.5.2,<3.0.0)", "mdx-include (>=1.4.1,<2.0.0)", "mkdocs (>=1.1.2,<2.0.0)", "mkdocs-material (>=8.1.4,<9.0.0)", "pillow (>=9.3.0,<10.0.0)"] test = ["black (>=22.3.0,<23.0.0)", "coverage (>=6.2,<7.0)", "isort (>=5.0.6,<6.0.0)", "mypy (==0.910)", "pytest (>=4.4.0,<8.0.0)", "pytest-cov (>=2.10.0,<5.0.0)", "pytest-sugar (>=0.9.4,<0.10.0)", "pytest-xdist (>=1.32.0,<4.0.0)", "rich (>=10.11.0,<13.0.0)", "shellingham (>=1.3.0,<2.0.0)"] +[[package]] +name = "types-beautifulsoup4" +version = "4.12.0.20250516" +description = "Typing stubs for beautifulsoup4" +optional = false +python-versions = ">=3.9" +groups = ["dev"] +files = [ + {file = "types_beautifulsoup4-4.12.0.20250516-py3-none-any.whl", hash = "sha256:5923399d4a1ba9cc8f0096fe334cc732e130269541d66261bb42ab039c0376ee"}, + {file = "types_beautifulsoup4-4.12.0.20250516.tar.gz", hash = "sha256:aa19dd73b33b70d6296adf92da8ab8a0c945c507e6fb7d5db553415cc77b417e"}, +] + +[package.dependencies] +types-html5lib = "*" + +[[package]] +name = "types-html5lib" +version = "1.1.11.20250917" +description = "Typing stubs for html5lib" +optional = false +python-versions = ">=3.9" +groups = ["dev"] +files = [ + {file = "types_html5lib-1.1.11.20250917-py3-none-any.whl", hash = "sha256:b294fd06d60da205daeb2f615485ca4d475088d2eff1009cf427f4a80fcd5346"}, + {file = "types_html5lib-1.1.11.20250917.tar.gz", hash = "sha256:7b52743377f33f9b4fd7385afbd2d457b8864ee51f90ff2a795ad9e8c053373a"}, +] + [[package]] name = "typing-extensions" version = "4.12.2" @@ -2793,4 +2832,4 @@ type = ["pytest-mypy"] [metadata] lock-version = "2.1" python-versions = "^3.9" -content-hash = "252da0cae6f5fb6faecec0aa4f64adca50835709419bb988dd723c5b50d0250e" +content-hash = "f3fee1a035bfc50965fe6a5fdeab8c17e871e7be0e4ad752c7e5ab9a409656bd" diff --git a/poetry.toml b/poetry.toml new file mode 100644 index 0000000..ab1033b --- /dev/null +++ b/poetry.toml @@ -0,0 +1,2 @@ +[virtualenvs] +in-project = true diff --git a/pyproject.toml b/pyproject.toml index 5a322d9..12d91c2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,6 +12,7 @@ PyYAML = "^6.0" jupyter-book = "^0.15.1" docutils = "0.17.1" lxml = "^6.0.1" +standard-imghdr = "^3.13.0" [tool.poetry.scripts] jb2htmlbook = "jupyter_book_to_htmlbook.main:main" @@ -20,6 +21,7 @@ jb2atlas = "jupyter_book_to_htmlbook.main:main" [tool.poetry.group.dev.dependencies] pytest = "^8.4.2" pytest-cov = "^7.0.0" +types-beautifulsoup4 = "^4.12.0.20250516" [build-system] requires = ["poetry-core>=1.0.0"] diff --git a/tests/example_book/_build/html/bibliography.html b/tests/example_book/_build/html/bibliography.html index ca6f1c4..7d83f02 100644 --- a/tests/example_book/_build/html/bibliography.html +++ b/tests/example_book/_build/html/bibliography.html @@ -3,7 +3,7 @@ - + @@ -15,19 +15,19 @@ - - - + + + - - - - + + + + @@ -38,8 +38,9 @@ - - + + + @@ -74,19 +75,23 @@ - + + +
+ + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
@@ -108,13 +113,21 @@ Ctrl+K
+ +
+ +
+ - +
+
+
+ +
@@ -128,6 +141,9 @@
+ + +
@@ -163,11 +180,6 @@ -

Edge Cases

-

References

    @@ -190,7 +202,7 @@
-
+
@@ -199,7 +211,7 @@
-
+
@@ -281,20 +293,22 @@ + + @@ -321,7 +335,7 @@

Bibliography

-
-
@@ -407,6 +417,7 @@

Bibliography +

© Copyright 2022. @@ -433,8 +444,8 @@

Bibliography - + +
diff --git a/tests/example_book/_build/html/genindex.html b/tests/example_book/_build/html/genindex.html index 912d883..9a5465c 100644 --- a/tests/example_book/_build/html/genindex.html +++ b/tests/example_book/_build/html/genindex.html @@ -3,7 +3,7 @@ - + @@ -14,19 +14,19 @@ - - - + + + - - - - + + + + @@ -37,8 +37,9 @@ - - + + + @@ -72,19 +73,23 @@ - + + +
+ + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
@@ -106,13 +111,23 @@ Ctrl+K

+ +
+ +
+ - +
+
+
+ + + +
@@ -126,6 +141,9 @@
+ + +
@@ -183,7 +202,7 @@
-
+
@@ -192,7 +211,7 @@
-
+
@@ -226,20 +245,22 @@ + + @@ -266,7 +287,7 @@

-
+

Index

@@ -303,16 +324,12 @@

G

-
+ + +
-
- -
-
-
-
@@ -335,6 +352,7 @@

G

+

© Copyright 2022. @@ -361,8 +379,8 @@

G

- - + +
diff --git a/tests/example_book/_build/html/intro.html b/tests/example_book/_build/html/intro.html index 9804a8f..0a8fcb0 100644 --- a/tests/example_book/_build/html/intro.html +++ b/tests/example_book/_build/html/intro.html @@ -3,7 +3,7 @@ - + @@ -15,19 +15,19 @@ - - - + + + - - - - + + + + @@ -38,8 +38,9 @@ - - + + + @@ -74,19 +75,23 @@ - + + +
+ + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
@@ -108,13 +113,23 @@ Ctrl+K
+ +
+ +
+ - +
+
+
+ + + +
@@ -128,6 +143,9 @@
+ + +
@@ -185,7 +204,7 @@
-
+
@@ -194,7 +213,7 @@
-
+
@@ -276,20 +295,22 @@ + + @@ -316,7 +337,7 @@

An Example Jupyter Book

-
@@ -421,6 +438,7 @@

An Example Jupyter Book +

© Copyright 2022. @@ -447,8 +465,8 @@

An Example Jupyter Book - - + +
diff --git a/tests/example_book/_build/html/notebooks/ch01.html b/tests/example_book/_build/html/notebooks/ch01.html index 85c568c..8a64ffa 100644 --- a/tests/example_book/_build/html/notebooks/ch01.html +++ b/tests/example_book/_build/html/notebooks/ch01.html @@ -3,7 +3,7 @@ - + @@ -15,19 +15,19 @@ - - - + + + - - - - + + + + @@ -38,8 +38,9 @@ - - + + + @@ -75,19 +76,23 @@ - + + +
+ + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
@@ -109,13 +114,21 @@ Ctrl+K

+ +
+ +
+ - +
+
+
+ +
@@ -129,6 +142,9 @@
+ + +
@@ -164,11 +181,6 @@ -

Edge Cases

-

References

    @@ -191,7 +203,7 @@
-
+
@@ -200,7 +212,7 @@
-
+
@@ -282,20 +294,22 @@ + + @@ -322,7 +336,7 @@

Jupyter Notebooks and Atlas

-
+

Jupyter Notebooks and Atlas#

@@ -335,7 +349,7 @@

Jupyter Notebooks and Atlas

Also, why not some executable code? See the following:

-
def hello(name: str):
+
def hello(name: str):
     print(f"Hello, {name}")
 
 hello("Jane")
@@ -430,11 +444,10 @@ 
Jupyter Notebooks and Atlas

 
               
               
-                

-
                 
               
             

@@ -480,6 +490,7 @@ 
Jupyter Notebooks and Atlas

   
   

     
+
   

     
       © Copyright 2022.
@@ -506,8 +517,8 @@ 
Jupyter Notebooks and Atlas

   

   
   
-  
-
+  
+
 
   

   

diff --git a/tests/example_book/_build/html/notebooks/ch02.00.html b/tests/example_book/_build/html/notebooks/ch02.00.html
index aaa95fc..d86fbca 100644
--- a/tests/example_book/_build/html/notebooks/ch02.00.html
+++ b/tests/example_book/_build/html/notebooks/ch02.00.html
@@ -3,7 +3,7 @@
 
 
 
-
+
 
   
     
@@ -15,19 +15,19 @@
   
   
   
   
-  
-
-
+  
+
+
 
   
-  
-  
-
-
+  
+  
+
+
 
     
     
@@ -38,8 +38,9 @@
     
   
   
-  
-
+  
+
+  
 
     
     
@@ -75,19 +76,23 @@
 
   
   
-  
+  
+  
+  

+  
+  
+
   
   
-  
+          id="pst-primary-sidebar-checkbox"/>
+  
   
   
-  
+          id="pst-secondary-sidebar-checkbox"/>
+  
   
   

     

@@ -109,13 +114,21 @@
   Ctrl+K
+ +
+ +
+ - +
+
+
+ +
@@ -129,6 +142,9 @@
+ + +
@@ -164,11 +181,6 @@ -

Edge Cases

-

References

    @@ -191,7 +203,7 @@
-
+
@@ -200,7 +212,7 @@
-
+
@@ -282,20 +294,22 @@ + + @@ -334,7 +348,7 @@

Contents

-
@@ -445,6 +455,7 @@

Bibliography
+
Contents @@ -475,6 +486,7 @@

Bibliography +

© Copyright 2022. @@ -501,8 +513,8 @@

Bibliography - + +
diff --git a/tests/example_book/_build/html/notebooks/ch02.01.html b/tests/example_book/_build/html/notebooks/ch02.01.html index 7bdaacb..53410eb 100644 --- a/tests/example_book/_build/html/notebooks/ch02.01.html +++ b/tests/example_book/_build/html/notebooks/ch02.01.html @@ -3,7 +3,7 @@ - + @@ -15,19 +15,19 @@ - - - + + + - - - - + + + + @@ -38,8 +38,9 @@ - - + + + @@ -75,19 +76,23 @@ - + + +
+ + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
@@ -109,13 +114,21 @@ Ctrl+K

+ +
+ +
+ - +
+
+
+ +
@@ -129,6 +142,9 @@
+ + +
@@ -164,11 +181,6 @@ -

Edge Cases

-

References

    @@ -191,7 +203,7 @@
-
+
@@ -200,7 +212,7 @@
-
+
@@ -282,20 +294,22 @@ + + @@ -334,7 +348,7 @@

Contents

-
+

This Is a Chapter Section in Its Own File#

@@ -342,7 +356,7 @@

This Is a Chapter Section in Its Own File
-
def print_me(n: int):
+
def print_me(n: int):
     print("Me!" * n)
 

 

@@ -392,11 +406,10 @@ 
Bibliography
+              
+              
+
@@ -428,6 +438,7 @@

Bibliography
+
Contents @@ -458,6 +469,7 @@

Bibliography +

© Copyright 2022. @@ -484,8 +496,8 @@

Bibliography - + +
diff --git a/tests/example_book/_build/html/notebooks/ch02.02.html b/tests/example_book/_build/html/notebooks/ch02.02.html index d452d20..28fcf5b 100644 --- a/tests/example_book/_build/html/notebooks/ch02.02.html +++ b/tests/example_book/_build/html/notebooks/ch02.02.html @@ -3,7 +3,7 @@ - + @@ -15,19 +15,19 @@ - - - + + + - - - - + + + + @@ -38,8 +38,9 @@ - - + + + @@ -75,19 +76,23 @@ - + + +
+ + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
@@ -109,13 +114,21 @@ Ctrl+K

+ +
+ +
+ - +
+
+
+ +
@@ -129,6 +142,9 @@
+ + +
@@ -164,11 +181,6 @@ -

Edge Cases

-

References

    @@ -191,7 +203,7 @@
-
+
@@ -200,7 +212,7 @@
-
+
@@ -282,20 +294,22 @@ + + @@ -342,7 +356,7 @@

Contents

-
@@ -430,6 +440,7 @@

Summary
+
Contents @@ -468,6 +479,7 @@

Summary +

© Copyright 2022. @@ -494,8 +506,8 @@

Summary - + +
diff --git a/tests/example_book/_build/html/notebooks/code_py.html b/tests/example_book/_build/html/notebooks/code_py.html index b1b9554..a9be569 100644 --- a/tests/example_book/_build/html/notebooks/code_py.html +++ b/tests/example_book/_build/html/notebooks/code_py.html @@ -3,7 +3,7 @@ - + @@ -15,19 +15,19 @@ - - - + + + - - - - + + + + @@ -38,8 +38,9 @@ - - + + + @@ -75,19 +76,23 @@ - + + +
+ + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
@@ -109,13 +114,21 @@ Ctrl+K

+ +
+ +
+ - +
+
+
+ +
@@ -129,6 +142,9 @@
+ + +
@@ -164,11 +181,6 @@ -

Edge Cases

-

References

    @@ -191,7 +203,7 @@
-
+
@@ -200,7 +212,7 @@
-
+
@@ -282,20 +294,22 @@ + + @@ -322,14 +336,14 @@

Code

-
+

Code#

Here is some in/out code:

-
def example(phrase):
+
def example(phrase):
     for i in phrase:
         if i in "hello":
             print(phrase)
@@ -367,7 +381,7 @@ 
Code#
# hello_tim
 # An example "Hello Tim" code example
 
-def hello(name="Tim"):
+def hello(name="Tim"):
     print(f"Hello, {name}! Nice to meet you!")
 

 

@@ -416,11 +430,10 @@ 
Code#
+              
+              
+                
               
             

@@ -466,6 +476,7 @@ 
Code#
     
+
   

     
       © Copyright 2022.
@@ -492,8 +503,8 @@ 
Code#
   
   
-  
-
+  
+
 
   

   

diff --git a/tests/example_book/_build/html/notebooks/code_r.html b/tests/example_book/_build/html/notebooks/code_r.html
index c3645ea..d817556 100644
--- a/tests/example_book/_build/html/notebooks/code_r.html
+++ b/tests/example_book/_build/html/notebooks/code_r.html
@@ -3,7 +3,7 @@
 
 
 
-
+
 
   
     
@@ -15,19 +15,19 @@
   
   
   
   
-  
-
-
+  
+
+
 
   
-  
-  
-
-
+  
+  
+
+
 
     
     
@@ -38,8 +38,9 @@
     
   
   
-  
-
+  
+
+  
 
     
     
@@ -64,7 +65,7 @@
     
     
     
-    
+    
     
   
   
@@ -75,19 +76,23 @@
 
   
   
-  
+  
+  
+  

+  
+  
+
   
   
-  
+          id="pst-primary-sidebar-checkbox"/>
+  
   
   
-  
+          id="pst-secondary-sidebar-checkbox"/>
+  
   
   

     

@@ -109,13 +114,21 @@
   Ctrl+K
+ +
+ +
+ - +
+
+
+ +
@@ -129,6 +142,9 @@
+ + +
@@ -164,11 +181,6 @@ -

Edge Cases

-

References

    @@ -191,7 +203,7 @@
-
+
@@ -200,7 +212,7 @@
-
+
@@ -282,20 +294,22 @@ + + @@ -322,7 +336,7 @@

This Is a Title

-
@@ -488,6 +498,7 @@

This Is a Title +

© Copyright 2022. @@ -514,8 +525,8 @@

This Is a Title - + +
diff --git a/tests/example_book/_build/html/notebooks/footnotes.html b/tests/example_book/_build/html/notebooks/footnotes.html index 436d506..d7e16de 100644 --- a/tests/example_book/_build/html/notebooks/footnotes.html +++ b/tests/example_book/_build/html/notebooks/footnotes.html @@ -3,7 +3,7 @@ - + @@ -15,19 +15,19 @@ - - - + + + - - - - + + + + @@ -38,8 +38,9 @@ - - + + + @@ -75,19 +76,23 @@ - + + +
+ + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
@@ -109,13 +114,21 @@ Ctrl+K

+ +
+ +
+ - +
+
+
+ +
@@ -129,6 +142,9 @@
+ + +
@@ -164,11 +181,6 @@ -

Edge Cases

-

References

    @@ -191,7 +203,7 @@
-
+
@@ -200,7 +212,7 @@
-
+
@@ -282,20 +294,22 @@ + + @@ -322,7 +336,7 @@

Footnote Test

-
@@ -417,6 +427,7 @@

Footnote Test +

© Copyright 2022. @@ -443,8 +454,8 @@

Footnote Test - + +
diff --git a/tests/example_book/_build/html/notebooks/glossary.html b/tests/example_book/_build/html/notebooks/glossary.html index 11e74c9..98cd94e 100644 --- a/tests/example_book/_build/html/notebooks/glossary.html +++ b/tests/example_book/_build/html/notebooks/glossary.html @@ -3,7 +3,7 @@ - + @@ -15,19 +15,19 @@ - - - + + + - - - - + + + + @@ -38,8 +38,9 @@ - - + + + @@ -75,19 +76,23 @@ - + + +
+ + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
@@ -109,13 +114,21 @@ Ctrl+K

+ +
+ +
+ - +
+
+
+ +
@@ -129,6 +142,9 @@
+ + +
@@ -164,11 +181,6 @@ -

Edge Cases

-

References

    @@ -191,7 +203,7 @@
-
+
@@ -200,7 +212,7 @@
-
+
@@ -282,20 +294,22 @@ + + @@ -322,7 +336,7 @@

Glossary

-
+

Glossary#

@@ -367,11 +381,10 @@

Glossary

-

-
-
-
@@ -417,6 +427,7 @@

Glossary

+

© Copyright 2022. @@ -443,8 +454,8 @@

Glossary

- - + +
diff --git a/tests/example_book/_build/html/notebooks/many_a_levels.html b/tests/example_book/_build/html/notebooks/many_a_levels.html index 16482a3..bd5f769 100644 --- a/tests/example_book/_build/html/notebooks/many_a_levels.html +++ b/tests/example_book/_build/html/notebooks/many_a_levels.html @@ -3,7 +3,7 @@ - + @@ -15,19 +15,19 @@ - - - + + + - - - - + + + + @@ -38,8 +38,9 @@ - - + + + @@ -64,8 +65,6 @@ - - @@ -75,19 +74,23 @@ - + + +
+ + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
@@ -109,13 +112,23 @@ Ctrl+K
+ +
+ +
+ - +
+
+
+ + + +
@@ -129,6 +142,9 @@
+ + +
@@ -164,11 +181,6 @@ -

Edge Cases

-

References

    @@ -191,7 +203,7 @@
-
+
@@ -200,7 +212,7 @@
-
+
@@ -282,20 +294,22 @@ + + @@ -334,7 +348,7 @@

Contents

-
+

My Main Title#

@@ -347,7 +361,7 @@

Example: A Second Main Headingaliquam tristique malesuada. Cras metus felis, laoreet id feugiat eu, blandit ut dolor. Quisque porta tellus non maximus mattis. Phasellus ac condimentum turpis, non tempus elit. Fusce porta, leo nec facilisis efficitur, augue dolor mollis turpis, a dignissim est neque a risus. Nunc lacinia diam facilisis placerat aliquam. Nullam massa turpis, egestas interdum odio vel, consectetur congue ante. Donec faucibus libero pretium nisi faucibus consequat. Maecenas et tempor purus, eu posuere velit. Cras hendrerit tincidunt ex, vitae ullamcorper elit mollis fringilla. In convallis erat in ex facilisis, in elementum velit ullamcorper. Duis interdum feugiat nibh, vitae porta nisl.

-
def hello():
+
def hello():
     print("Hello, world")
 
 hello()
@@ -392,34 +406,12 @@ 
Example: A Second Main Heading
+              
+              
+                
               
             

@@ -428,6 +420,7 @@ 
Example: A Second Main Heading

 
+
   

   

      Contents
@@ -458,6 +451,7 @@ 
Example: A Second Main Heading
     
+
   

     
       © Copyright 2022.
@@ -484,8 +478,8 @@ 
Example: A Second Main Heading
-
+  
+
 
   

   

diff --git a/tests/example_book/_build/html/notebooks/markup.html b/tests/example_book/_build/html/notebooks/markup.html
index a2585a0..82997fb 100644
--- a/tests/example_book/_build/html/notebooks/markup.html
+++ b/tests/example_book/_build/html/notebooks/markup.html
@@ -3,7 +3,7 @@
 
 
 
-
+
 
   
     
@@ -15,19 +15,19 @@
   
   
   
   
-  
-
-
+  
+
+
 
   
-  
-  
-
-
+  
+  
+
+
 
     
     
@@ -38,8 +38,9 @@
     
   
   
-  
-
+  
+
+  
 
     
     
@@ -65,7 +66,7 @@
     
     
     
-    
+    
   
   
   
@@ -75,19 +76,23 @@
 
   
   
-  
+  
+  
+  

+  
+  
+
   
   
-  
+          id="pst-primary-sidebar-checkbox"/>
+  
   
   
-  
+          id="pst-secondary-sidebar-checkbox"/>
+  
   
   

     

@@ -109,13 +114,21 @@
   Ctrl+K
 

   

+
+  

+  
+

+
   
-    
+    

+    

   
+
   

     

       
+      
+      
       

         
 
@@ -129,6 +142,9 @@
   
     

         

+
+  
+    
   
 
 

@@ -164,11 +181,6 @@
 
-
Edge Cases

-
 
References

 
    
@@ -191,7 +203,7 @@
 
       

       
-      

+      

         
         
 
@@ -200,7 +212,7 @@
           

             

               
-              

+              

 

   
     

@@ -282,20 +294,22 @@
 
 
 
+
 
 
+
 
@@ -322,7 +336,7 @@ 
Markup Tests

               
                 
 
-                

+                

                   
   

 
Markup Tests#

@@ -356,7 +370,7 @@ 
Some Title

 
  • This is a second bullet point, with some formatting which must, remember, be done in HTML as a part of the passthrough.
    • 
 
 
    Also did we mention tables? Tables. Borrowed from the example docs, see Table 1
    
-
+
    @@ -376,6 +390,7 @@ 
    Some Title
    
 Table 1 Table title#
 
 

 
 
 
    
+
    
 
    Of course, sometimes a pagebreak is needed. If it’s a paragraph, you can do something like the following:
    
 
    <p class="pagebreak-before">
 Just like in a regular HTML book!
@@ -422,19 +437,18 @@ 
    Summary
    
 
               
               
-                
    
       
    
       
     
-
    -
    -
    @@ -472,6 +483,7 @@

    Summary

    +

    © Copyright 2022. @@ -498,8 +510,8 @@

    Summary

    - - + +
    diff --git a/tests/example_book/_build/html/notebooks/preface.html b/tests/example_book/_build/html/notebooks/preface.html index 6e211c7..1c49ed7 100644 --- a/tests/example_book/_build/html/notebooks/preface.html +++ b/tests/example_book/_build/html/notebooks/preface.html @@ -3,7 +3,7 @@ - + @@ -15,19 +15,19 @@ - - - + + + - - - - + + + + @@ -38,8 +38,9 @@ - - + + + @@ -75,19 +76,23 @@ - + + +
    + + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
    @@ -109,13 +114,21 @@ Ctrl+K
    + +
    + +
    + - +
    +
    +
    + +
    @@ -129,6 +142,9 @@
    + + +
    @@ -164,11 +181,6 @@ -

    Edge Cases

    -

    References

      @@ -191,7 +203,7 @@
    -
    +
    @@ -200,7 +212,7 @@
    -
    +
    @@ -282,20 +294,22 @@ + + @@ -334,7 +348,7 @@

    Contents

    -
    @@ -424,6 +434,7 @@

    What is the Process?
    +
    Contents @@ -454,6 +465,7 @@

    What is the Process? +

    © Copyright 2022. @@ -480,8 +492,8 @@

    What is the Process? - - + +
    diff --git a/tests/example_book/_build/html/search.html b/tests/example_book/_build/html/search.html index fe5a062..4ac0dcb 100644 --- a/tests/example_book/_build/html/search.html +++ b/tests/example_book/_build/html/search.html @@ -3,7 +3,7 @@ - + @@ -13,19 +13,19 @@ - - - + + + - - - - + + + + @@ -36,8 +36,9 @@ - - + + + @@ -74,19 +75,23 @@ -     + + +
    + + + - + id="pst-primary-sidebar-checkbox"/> + - + id="pst-secondary-sidebar-checkbox"/> +
    @@ -108,13 +113,23 @@ Ctrl+K

    + +
    + +
    + - +
    +
    +
    + + + +
    @@ -128,6 +143,9 @@
    + + +
    @@ -185,7 +204,7 @@
    -
    +
    @@ -194,7 +213,7 @@
    -
    +
    @@ -228,20 +247,22 @@ + + @@ -293,16 +314,12 @@

    Search

    -
    + + +
    -
    - -
    -
    -
    -
    @@ -325,6 +342,7 @@

    Search

    +

    © Copyright 2022. @@ -351,8 +369,8 @@

    Search

    - - + +
    diff --git a/tests/example_book_2/_config.yml b/tests/example_book_2/_config.yml new file mode 100644 index 0000000..5f534f8 --- /dev/null +++ b/tests/example_book_2/_config.yml @@ -0,0 +1,32 @@ +# Book settings +# Learn more at https://jupyterbook.org/customize/config.html + +title: My sample book +author: The Jupyter Book Community +logo: logo.png + +# Force re-execution of notebooks on each build. +# See https://jupyterbook.org/content/execute.html +execute: + execute_notebooks: force + +# Define the name of the latex output file for PDF builds +latex: + latex_documents: + targetname: book.tex + +# Add a bibtex file so that we can create citations +bibtex_bibfiles: + - references.bib + +# Information about where the book exists on the web +repository: + url: https://github.com/executablebooks/jupyter-book # Online location of your book + path_to_book: docs # Optional path to your book, relative to the repository root + branch: master # Which branch of the repository should be used when creating links (optional) + +# Add GitHub buttons to your book +# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository +html: + use_issues_button: true + use_repository_button: true diff --git a/tests/example_book_2/_toc.yml b/tests/example_book_2/_toc.yml new file mode 100644 index 0000000..74d5c71 --- /dev/null +++ b/tests/example_book_2/_toc.yml @@ -0,0 +1,9 @@ +# Table of contents +# Learn more at https://jupyterbook.org/customize/toc.html + +format: jb-book +root: intro +chapters: +- file: markdown +- file: notebooks +- file: markdown-notebooks diff --git a/tests/example_book_2/intro.md b/tests/example_book_2/intro.md new file mode 100644 index 0000000..f8cdc73 --- /dev/null +++ b/tests/example_book_2/intro.md @@ -0,0 +1,11 @@ +# Welcome to your Jupyter Book + +This is a small sample book to give you a feel for how book content is +structured. +It shows off a few of the major file types, as well as some sample content. +It does not go in-depth into any particular topic - check out [the Jupyter Book documentation](https://jupyterbook.org) for more information. + +Check out the content pages bundled with this sample book to see more. + +```{tableofcontents} +``` diff --git a/tests/example_book_2/logo.png b/tests/example_book_2/logo.png new file mode 100644 index 0000000..06d56f4 Binary files /dev/null and b/tests/example_book_2/logo.png differ diff --git a/tests/example_book_2/markdown-notebooks.md b/tests/example_book_2/markdown-notebooks.md new file mode 100644 index 0000000..a057a32 --- /dev/null +++ b/tests/example_book_2/markdown-notebooks.md @@ -0,0 +1,53 @@ +--- +jupytext: + formats: md:myst + text_representation: + extension: .md + format_name: myst + format_version: 0.13 + jupytext_version: 1.11.5 +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + +# Notebooks with MyST Markdown + +Jupyter Book also lets you write text-based notebooks using MyST Markdown. +See [the Notebooks with MyST Markdown documentation](https://jupyterbook.org/file-types/myst-notebooks.html) for more detailed instructions. +This page shows off a notebook written in MyST Markdown. + +## An example cell + +With MyST Markdown, you can define code cells with a directive like so: + +```{code-cell} +print(2 + 2) +``` + +When your book is built, the contents of any `{code-cell}` blocks will be +executed with your default Jupyter kernel, and their outputs will be displayed +in-line with the rest of your content. + +```{seealso} +Jupyter Book uses [Jupytext](https://jupytext.readthedocs.io/en/latest/) to convert text-based files to notebooks, and can support [many other text-based notebook files](https://jupyterbook.org/file-types/jupytext.html). +``` + +## Create a notebook with MyST Markdown + +MyST Markdown notebooks are defined by two things: + +1. YAML metadata that is needed to understand if / how it should convert text files to notebooks (including information about the kernel needed). + See the YAML at the top of this page for example. +2. The presence of `{code-cell}` directives, which will be executed with your book. + +That's all that is needed to get started! + +## Quickly add YAML metadata for MyST Notebooks + +If you have a markdown file and you'd like to quickly add YAML metadata to it, so that Jupyter Book will treat it as a MyST Markdown Notebook, run the following command: + +``` +jupyter-book myst init path/to/markdownfile.md +``` diff --git a/tests/example_book_2/markdown.md b/tests/example_book_2/markdown.md new file mode 100644 index 0000000..faeea60 --- /dev/null +++ b/tests/example_book_2/markdown.md @@ -0,0 +1,55 @@ +# Markdown Files + +Whether you write your book's content in Jupyter Notebooks (`.ipynb`) or +in regular markdown files (`.md`), you'll write in the same flavor of markdown +called **MyST Markdown**. +This is a simple file to help you get started and show off some syntax. + +## What is MyST? + +MyST stands for "Markedly Structured Text". It +is a slight variation on a flavor of markdown called "CommonMark" markdown, +with small syntax extensions to allow you to write **roles** and **directives** +in the Sphinx ecosystem. + +For more about MyST, see [the MyST Markdown Overview](https://jupyterbook.org/content/myst.html). + +## Sample Roles and Directives + +Roles and directives are two of the most powerful tools in Jupyter Book. They +are like functions, but written in a markup language. They both +serve a similar purpose, but **roles are written in one line**, whereas +**directives span many lines**. They both accept different kinds of inputs, +and what they do with those inputs depends on the specific role or directive +that is being called. + +Here is a "note" directive: + +```{note} +Here is a note +``` + +It will be rendered in a special box when you build your book. + +Here is an inline directive to refer to a document: {doc}`markdown-notebooks`. + + +## Citations + +You can also cite references that are stored in a `bibtex` file. For example, +the following syntax: `` {cite}`holdgraf_evidence_2014` `` will render like +this: {cite}`holdgraf_evidence_2014`. + +Moreover, you can insert a bibliography into your page with this syntax: +The `{bibliography}` directive must be used for all the `{cite}` roles to +render properly. +For example, if the references for your book are stored in `references.bib`, +then the bibliography is inserted with: + +```{bibliography} +``` + +## Learn more + +This is just a simple starter to get you started. +You can learn a lot more at [jupyterbook.org](https://jupyterbook.org). diff --git a/tests/example_book_2/notebooks.ipynb b/tests/example_book_2/notebooks.ipynb new file mode 100644 index 0000000..fdb7176 --- /dev/null +++ b/tests/example_book_2/notebooks.ipynb @@ -0,0 +1,122 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Content with notebooks\n", + "\n", + "You can also create content with Jupyter Notebooks. This means that you can include\n", + "code blocks and their outputs in your book.\n", + "\n", + "## Markdown + notebooks\n", + "\n", + "As it is markdown, you can embed images, HTML, etc into your posts!\n", + "\n", + "![](https://myst-parser.readthedocs.io/en/latest/_static/logo-wide.svg)\n", + "\n", + "You can also $add_{math}$ and\n", + "\n", + "$$\n", + "math^{blocks}\n", + "$$\n", + "\n", + "or\n", + "\n", + "$$\n", + "\\begin{aligned}\n", + "\\mbox{mean} la_{tex} \\\\ \\\\\n", + "math blocks\n", + "\\end{aligned}\n", + "$$\n", + "\n", + "But make sure you \\$Escape \\$your \\$dollar signs \\$you want to keep!\n", + "\n", + "## MyST markdown\n", + "\n", + "MyST markdown works in Jupyter Notebooks as well. For more information about MyST markdown, check\n", + "out [the MyST guide in Jupyter Book](https://jupyterbook.org/content/myst.html),\n", + "or see [the MyST markdown documentation](https://myst-parser.readthedocs.io/en/latest/).\n", + "\n", + "## Code blocks and outputs\n", + "\n", + "Jupyter Book will also embed your code blocks and output in your book.\n", + "For example, here's some sample Matplotlib code:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "from matplotlib import rcParams, cycler\n", + "import matplotlib.pyplot as plt\n", + "import numpy as np\n", + "plt.ion()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "# Fixing random state for reproducibility\n", + "np.random.seed(19680801)\n", + "\n", + "N = 10\n", + "data = [np.logspace(0, 1, 100) + np.random.randn(100) + ii for ii in range(N)]\n", + "data = np.array(data).T\n", + "cmap = plt.cm.coolwarm\n", + "rcParams['axes.prop_cycle'] = cycler(color=cmap(np.linspace(0, 1, N)))\n", + "\n", + "\n", + "from matplotlib.lines import Line2D\n", + "custom_lines = [Line2D([0], [0], color=cmap(0.), lw=4),\n", + " Line2D([0], [0], color=cmap(.5), lw=4),\n", + " Line2D([0], [0], color=cmap(1.), lw=4)]\n", + "\n", + "fig, ax = plt.subplots(figsize=(10, 5))\n", + "lines = ax.plot(data)\n", + "ax.legend(custom_lines, ['Cold', 'Medium', 'Hot']);" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "There is a lot more that you can do with outputs (such as including interactive outputs)\n", + "with your book. For more information about this, see [the Jupyter Book documentation](https://jupyterbook.org)" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.8.0" + }, + "widgets": { + "application/vnd.jupyter.widget-state+json": { + "state": {}, + "version_major": 2, + "version_minor": 0 + } + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/tests/example_book_2/references.bib b/tests/example_book_2/references.bib new file mode 100644 index 0000000..783ec6a --- /dev/null +++ b/tests/example_book_2/references.bib @@ -0,0 +1,56 @@ +--- +--- + +@inproceedings{holdgraf_evidence_2014, + address = {Brisbane, Australia, Australia}, + title = {Evidence for {Predictive} {Coding} in {Human} {Auditory} {Cortex}}, + booktitle = {International {Conference} on {Cognitive} {Neuroscience}}, + publisher = {Frontiers in Neuroscience}, + author = {Holdgraf, Christopher Ramsay and de Heer, Wendy and Pasley, Brian N. and Knight, Robert T.}, + year = {2014} +} + +@article{holdgraf_rapid_2016, + title = {Rapid tuning shifts in human auditory cortex enhance speech intelligibility}, + volume = {7}, + issn = {2041-1723}, + url = {http://www.nature.com/doifinder/10.1038/ncomms13654}, + doi = {10.1038/ncomms13654}, + number = {May}, + journal = {Nature Communications}, + author = {Holdgraf, Christopher Ramsay and de Heer, Wendy and Pasley, Brian N. and Rieger, Jochem W. and Crone, Nathan and Lin, Jack J. and Knight, Robert T. and Theunissen, Frédéric E.}, + year = {2016}, + pages = {13654}, + file = {Holdgraf et al. - 2016 - Rapid tuning shifts in human auditory cortex enhance speech intelligibility.pdf:C\:\\Users\\chold\\Zotero\\storage\\MDQP3JWE\\Holdgraf et al. - 2016 - Rapid tuning shifts in human auditory cortex enhance speech intelligibility.pdf:application/pdf} +} + +@inproceedings{holdgraf_portable_2017, + title = {Portable learning environments for hands-on computational instruction using container-and cloud-based technology to teach data science}, + volume = {Part F1287}, + isbn = {978-1-4503-5272-7}, + doi = {10.1145/3093338.3093370}, + abstract = {© 2017 ACM. There is an increasing interest in learning outside of the traditional classroom setting. This is especially true for topics covering computational tools and data science, as both are challenging to incorporate in the standard curriculum. These atypical learning environments offer new opportunities for teaching, particularly when it comes to combining conceptual knowledge with hands-on experience/expertise with methods and skills. Advances in cloud computing and containerized environments provide an attractive opportunity to improve the effciency and ease with which students can learn. This manuscript details recent advances towards using commonly-Available cloud computing services and advanced cyberinfrastructure support for improving the learning experience in bootcamp-style events. We cover the benets (and challenges) of using a server hosted remotely instead of relying on student laptops, discuss the technology that was used in order to make this possible, and give suggestions for how others could implement and improve upon this model for pedagogy and reproducibility.}, + booktitle = {{ACM} {International} {Conference} {Proceeding} {Series}}, + author = {Holdgraf, Christopher Ramsay and Culich, A. and Rokem, A. and Deniz, F. and Alegro, M. and Ushizima, D.}, + year = {2017}, + keywords = {Teaching, Bootcamps, Cloud computing, Data science, Docker, Pedagogy} +} + +@article{holdgraf_encoding_2017, + title = {Encoding and decoding models in cognitive electrophysiology}, + volume = {11}, + issn = {16625137}, + doi = {10.3389/fnsys.2017.00061}, + abstract = {© 2017 Holdgraf, Rieger, Micheli, Martin, Knight and Theunissen. Cognitive neuroscience has seen rapid growth in the size and complexity of data recorded from the human brain as well as in the computational tools available to analyze this data. This data explosion has resulted in an increased use of multivariate, model-based methods for asking neuroscience questions, allowing scientists to investigate multiple hypotheses with a single dataset, to use complex, time-varying stimuli, and to study the human brain under more naturalistic conditions. These tools come in the form of “Encoding” models, in which stimulus features are used to model brain activity, and “Decoding” models, in which neural features are used to generated a stimulus output. Here we review the current state of encoding and decoding models in cognitive electrophysiology and provide a practical guide toward conducting experiments and analyses in this emerging field. Our examples focus on using linear models in the study of human language and audition. We show how to calculate auditory receptive fields from natural sounds as well as how to decode neural recordings to predict speech. The paper aims to be a useful tutorial to these approaches, and a practical introduction to using machine learning and applied statistics to build models of neural activity. The data analytic approaches we discuss may also be applied to other sensory modalities, motor systems, and cognitive systems, and we cover some examples in these areas. In addition, a collection of Jupyter notebooks is publicly available as a complement to the material covered in this paper, providing code examples and tutorials for predictive modeling in python. The aimis to provide a practical understanding of predictivemodeling of human brain data and to propose best-practices in conducting these analyses.}, + journal = {Frontiers in Systems Neuroscience}, + author = {Holdgraf, Christopher Ramsay and Rieger, J.W. and Micheli, C. and Martin, S. and Knight, R.T. and Theunissen, F.E.}, + year = {2017}, + keywords = {Decoding models, Encoding models, Electrocorticography (ECoG), Electrophysiology/evoked potentials, Machine learning applied to neuroscience, Natural stimuli, Predictive modeling, Tutorials} +} + +@book{ruby, + title = {The Ruby Programming Language}, + author = {Flanagan, David and Matsumoto, Yukihiro}, + year = {2008}, + publisher = {O'Reilly Media} +} diff --git a/tests/example_book_2/requirements.txt b/tests/example_book_2/requirements.txt new file mode 100644 index 0000000..7e821e4 --- /dev/null +++ b/tests/example_book_2/requirements.txt @@ -0,0 +1,3 @@ +jupyter-book +matplotlib +numpy diff --git a/tests/test_bibliography.py b/tests/test_bibliography.py index 045e525..ad33bad 100644 --- a/tests/test_bibliography.py +++ b/tests/test_bibliography.py @@ -1,9 +1,9 @@ import shutil from bs4 import BeautifulSoup # type: ignore from jupyter_book_to_htmlbook.file_processing import ( - apply_datatype, - process_chapter - ) + apply_datatype, + process_chapter, +) from jupyter_book_to_htmlbook.reference_processing import process_citations @@ -22,15 +22,16 @@ def test_bib_appx_datatype(self, tmp_path): Given a "bibliography.*" filename, we want the main/chapter section to have an "appendix" data-type """ - test_env = tmp_path / 'tmp' + test_env = tmp_path / "tmp" test_env.mkdir() - shutil.copytree('tests/example_book/_build/html/', - test_env, dirs_exist_ok=True) - with open(test_env / 'bibliography.html') as f: + shutil.copytree( + "tests/example_book/_build/html/", test_env, dirs_exist_ok=True + ) + with open(test_env / "bibliography.html") as f: text = f.read() - chapter = BeautifulSoup(text, "lxml").find_all('section')[0] + chapter = BeautifulSoup(text, "lxml").find_all("section")[0] apply_datatype(chapter, "bibliography") - assert chapter["data-type"] == "appendix" + assert chapter["data-type"] == "appendix" # type: ignore def test_bib_appx_to_author_date(self): """ @@ -38,7 +39,8 @@ def test_bib_appx_to_author_date(self): file) from Jupyter Book, bibliographical citations should be in an unordered list with an "author-date" style applied to the list. """ - chapter = BeautifulSoup(""" + chapter = BeautifulSoup( + """
    Aad93

    Terry Aadams. The title of the work. The name of the journal, @@ -54,10 +56,12 @@ def test_bib_appx_to_author_date(self): of the publisher, 7 1993, An optional note.

    -""", "html.parser") +""", + "html.parser", + ) result = process_citations(chapter) assert not result.find("dl") - assert "author-date" in result.find("ul")["class"] + assert "author-date" in result.find("ul")["class"] # type: ignore assert len(result.find_all("li")) == 3 def test_bib_gets_moved_to_end(self, tmp_path): @@ -65,22 +69,29 @@ def test_bib_gets_moved_to_end(self, tmp_path): An in-chapter bibliography should be moved to the end of the main chapter section. """ - test_env = tmp_path / 'tmp' - test_out = test_env / 'output' + test_env = tmp_path / "tmp" + test_out = test_env / "output" test_env.mkdir() test_out.mkdir() - shutil.copytree('tests/example_book/_build/html/notebooks/', - test_env, dirs_exist_ok=True) - result = process_chapter([ - test_env / 'ch02.00.html', - test_env / 'ch02.01.html', - test_env / 'ch02.02.html', - ], test_env, test_out)[0] + shutil.copytree( + "tests/example_book/_build/html/notebooks/", + test_env, + dirs_exist_ok=True, + ) + result = process_chapter( + [ + test_env / "ch02.00.html", + test_env / "ch02.01.html", + test_env / "ch02.02.html", + ], + test_env, + test_out, + )[0] with open(test_out / result, "rt") as f: soup = BeautifulSoup(f.read(), "lxml") - assert soup.find_all("section")[-1]["id"] == "bibliography" - assert soup.find_all("section")[-1].find("ul", class_="author-date") + assert soup.find_all("section")[-1]["id"] == "bibliography" # type: ignore + assert soup.find_all("section")[-1].find("ul", class_="author-date") # type: ignore def test_sub_bibs_get_combined_appropriately(self, tmp_path): """ @@ -90,41 +101,56 @@ def test_sub_bibs_get_combined_appropriately(self, tmp_path): NOTE: This is not the ideal solution, but a "works enough for now" compromise. """ - test_env = tmp_path / 'tmp' - test_out = test_env / 'output' + test_env = tmp_path / "tmp" + test_out = test_env / "output" test_env.mkdir() test_out.mkdir() - shutil.copytree('tests/example_book/_build/html/notebooks/', - test_env, dirs_exist_ok=True) - result = process_chapter([ - test_env / 'ch02.00.html', - test_env / 'ch02.01.html', - test_env / 'ch02.02.html', - ], test_env, test_out)[0] + shutil.copytree( + "tests/example_book/_build/html/notebooks/", + test_env, + dirs_exist_ok=True, + ) + result = process_chapter( + [ + test_env / "ch02.00.html", + test_env / "ch02.01.html", + test_env / "ch02.02.html", + ], + test_env, + test_out, + )[0] + with open(test_out / result, "rt") as f: soup = BeautifulSoup(f.read(), "lxml") bib = soup.find("section", id="bibliography") assert len(soup.find_all("section", id="bibliography")) == 1 - assert len(bib.find("ul", class_="author-date").find_all("li")) == 4 + assert len(bib.find("ul", class_="author-date").find_all("li")) == 4 # type: ignore def test_single_sub_bib_becomes_bib(self, tmp_path): """ Coverage test to ensure that if we only have a bibliography in a sub-file, it gets used as the primary bibliography for that chapter """ - test_env = tmp_path / 'tmp' - test_out = test_env / 'output' + test_env = tmp_path / "tmp" + test_out = test_env / "output" test_env.mkdir() test_out.mkdir() - shutil.copytree('tests/example_book/_build/html/notebooks/', - test_env, dirs_exist_ok=True) - result = process_chapter([ - test_env / 'ch01.html', - test_env / 'ch02.01.html', - test_env / 'ch02.02.html', - ], test_env, test_out)[0] + shutil.copytree( + "tests/example_book/_build/html/notebooks/", + test_env, + dirs_exist_ok=True, + ) + result = process_chapter( + [ + test_env / "ch01.html", + test_env / "ch02.01.html", + test_env / "ch02.02.html", + ], + test_env, + test_out, + )[0] with open(test_out / result, "rt") as f: soup = BeautifulSoup(f.read(), "lxml") bib = soup.find("section", id="bibliography") assert len(soup.find_all("section", id="bibliography")) == 1 - assert len(bib.find("ul", class_="author-date").find_all("li")) == 3 + assert len(bib.find("ul", class_="author-date").find_all("li")) == 3 # type: ignore diff --git a/tests/test_file_processing.py b/tests/test_file_processing.py index 0a61ac5..23bbd6e 100644 --- a/tests/test_file_processing.py +++ b/tests/test_file_processing.py @@ -21,6 +21,8 @@ def test_compile_chapter_parts_happy_path(self, tmp_book_path): tmp_book_path / 'notebooks/ch02.01.html', tmp_book_path / 'notebooks/ch02.02.html', ])[0] + with open("check.html", "wt") as f: + f.write(str(result)) # the resulting section should have a data-type of "chapter" assert result["data-type"] == "chapter" # number of level-1 subsections should be one less than the group