Doc update

uds-se · Jan 13, 2025 · 1c20f34 · 1c20f34
1 parent abca76f
commit 1c20f34
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 25 deletions.
diff --git a/docs/beta/dist/debuggingbook-1.3.tar.gz b/docs/beta/dist/debuggingbook-1.3.tar.gz
diff --git a/docs/beta/dist/debuggingbook-code.zip b/docs/beta/dist/debuggingbook-code.zip
diff --git a/docs/beta/dist/debuggingbook-notebooks.zip b/docs/beta/dist/debuggingbook-notebooks.zip
diff --git a/docs/beta/html/Importing.html b/docs/beta/html/Importing.html
@@ -12010,7 +12010,11 @@
 <div class="text_cell_render border-box-sizing rendered_html"><h2 id="Can-I-import-the-code-for-my-own-Python-projects?">Can I import the code for my own Python projects?<a class="anchor-link" href="#Can-I-import-the-code-for-my-own-Python-projects?">&#182;</a></h2><p>Yes, you can!  (If you like Python, that is.)  We provide a <code>debuggingbook</code> Python package that you can install using the <code>pip</code> package manager:</p>
 <div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>debuggingbook
 </pre></div>
-<p>As of <code>debuggingbook 1.1</code>, this is set up such that additional required Python packages are also installed. However, also see "Install Additional Non-Python Packages" below.</p>
+<p>As of <code>debuggingbook 1.1</code>, this is set up such that additional required Python packages are also installed.
+However, also see "Install Additional Non-Python Packages" below.</p>
+<p>Note that after installation via <code>pip</code>, you may have to install our updated <code>showast</code> module:</p>
+<div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span><span class="s1">&#39;showast@git+https://github.com/andreas-zeller/show_ast.git@andreas&#39;</span>
+</pre></div>
 <p>Once <code>pip</code> is complete, you can import individual classes, constants, or functions from each notebook using</p>
 <div class="highlight"><pre><span></span><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn"><a href=".html" class="import" target="_blank">debuggingbook.</a></span><span class="o">&lt;</span><span class="n">notebook</span><span class="o">&gt;</span> <span class="kn">import</span> <span class="o">&lt;</span><span class="n">identifier</span><span class="o">&gt;</span>
 </pre></div>
@@ -12264,7 +12268,7 @@
 The content of this project is licensed under the
 <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/" target=_blank>Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
 The source code that is part of the content, as well as the source code used to format and display that content is licensed under the <a href="https://github.com/uds-se/debuggingbook/blob/master/LICENSE.md#mit-license">MIT License</a>.
-<a href="https://github.com/uds-se/debuggingbook/commits/master/notebooks/Importing.ipynb" target=_blank)>Last change: 2024-05-15 16:46:43+02:00</a> &bull; 
+<a href="https://github.com/uds-se/debuggingbook/commits/master/notebooks/Importing.ipynb" target=_blank)>Last change: 2025-01-13 16:59:45+01:00</a> &bull; 
 <a href="#citation" id="cite" onclick="revealCitation()">Cite</a> &bull;
 <a href="https://cispa.de/en/impressum" target=_blank>Imprint</a>
 </p>
@@ -12280,19 +12284,19 @@
 <a name="citation"></a>
 <h2>How to Cite this Work</h2>
 <p>
-Andreas Zeller: "<a href="https://www.debuggingbook.org/beta/html/Importing.html">Using Debuggingbook Code in your own Programs</a>".  In Andreas Zeller, "<a href="https://www.debuggingbook.org/beta/">The Debugging Book</a>", <a href="https://www.debuggingbook.org/beta/html/Importing.html">https://www.debuggingbook.org/beta/html/Importing.html</a>.  Retrieved 2024-05-15 16:46:43+02:00.
+Andreas Zeller: "<a href="https://www.debuggingbook.org/beta/html/Importing.html">Using Debuggingbook Code in your own Programs</a>".  In Andreas Zeller, "<a href="https://www.debuggingbook.org/beta/">The Debugging Book</a>", <a href="https://www.debuggingbook.org/beta/html/Importing.html">https://www.debuggingbook.org/beta/html/Importing.html</a>.  Retrieved 2025-01-13 16:59:45+01:00.
 </p>
 <pre>
-@incollection{debuggingbook2024:Importing,
+@incollection{debuggingbook2025:Importing,
     author = {Andreas Zeller},
     booktitle = {The Debugging Book},
     title = {Using Debuggingbook Code in your own Programs},
-    year = {2024},
+    year = {2025},
     publisher = {CISPA Helmholtz Center for Information Security},
     howpublished = {\url{https://www.debuggingbook.org/beta/html/Importing.html}},
-    note = {Retrieved 2024-05-15 16:46:43+02:00},
+    note = {Retrieved 2025-01-13 16:59:45+01:00},
     url = {https://www.debuggingbook.org/beta/html/Importing.html},
-    urldate = {2024-05-15 16:46:43+02:00}
+    urldate = {2025-01-13 16:59:45+01:00}
 }
 </pre>
 </div>

diff --git a/docs/beta/html/ReleaseNotes.html b/docs/beta/html/ReleaseNotes.html
@@ -12006,6 +12006,9 @@
 <li>Updates to <code>requirements.txt</code>, using the latest and greatest third-party modules</li>
 <li>Python 3.9 is no longer supported.</li>
 </ul>
+<p>Note that after installation via <code>pip</code>, you may have to install our updated <code>showast</code> module:</p>
+<div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span><span class="s1">&#39;showast@git+https://github.com/andreas-zeller/show_ast.git@andreas&#39;</span>
+</pre></div>
 </div>
 </div>
 </div>
@@ -12140,7 +12143,7 @@
 The content of this project is licensed under the
 <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/" target=_blank>Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
 The source code that is part of the content, as well as the source code used to format and display that content is licensed under the <a href="https://github.com/uds-se/debuggingbook/blob/master/LICENSE.md#mit-license">MIT License</a>.
-<a href="https://github.com/uds-se/debuggingbook/commits/master/notebooks/ReleaseNotes.ipynb" target=_blank)>Last change: 2025-01-13 15:47:28+01:00</a> &bull; 
+<a href="https://github.com/uds-se/debuggingbook/commits/master/notebooks/ReleaseNotes.ipynb" target=_blank)>Last change: 2025-01-13 16:58:56+01:00</a> &bull; 
 <a href="#citation" id="cite" onclick="revealCitation()">Cite</a> &bull;
 <a href="https://cispa.de/en/impressum" target=_blank>Imprint</a>
 </p>
@@ -12156,7 +12159,7 @@
 <a name="citation"></a>
 <h2>How to Cite this Work</h2>
 <p>
-Andreas Zeller: "<a href="https://www.debuggingbook.org/beta/html/ReleaseNotes.html">Release Notes for The Debugging Book</a>".  In Andreas Zeller, "<a href="https://www.debuggingbook.org/beta/">The Debugging Book</a>", <a href="https://www.debuggingbook.org/beta/html/ReleaseNotes.html">https://www.debuggingbook.org/beta/html/ReleaseNotes.html</a>.  Retrieved 2025-01-13 15:47:28+01:00.
+Andreas Zeller: "<a href="https://www.debuggingbook.org/beta/html/ReleaseNotes.html">Release Notes for The Debugging Book</a>".  In Andreas Zeller, "<a href="https://www.debuggingbook.org/beta/">The Debugging Book</a>", <a href="https://www.debuggingbook.org/beta/html/ReleaseNotes.html">https://www.debuggingbook.org/beta/html/ReleaseNotes.html</a>.  Retrieved 2025-01-13 16:58:56+01:00.
 </p>
 <pre>
 @incollection{debuggingbook2025:ReleaseNotes,
@@ -12166,9 +12169,9 @@ <h2>How to Cite this Work</h2>
     year = {2025},
     publisher = {CISPA Helmholtz Center for Information Security},
     howpublished = {\url{https://www.debuggingbook.org/beta/html/ReleaseNotes.html}},
-    note = {Retrieved 2025-01-13 15:47:28+01:00},
+    note = {Retrieved 2025-01-13 16:58:56+01:00},
     url = {https://www.debuggingbook.org/beta/html/ReleaseNotes.html},
-    urldate = {2025-01-13 15:47:28+01:00}
+    urldate = {2025-01-13 16:58:56+01:00}
 }
 </pre>
 </div>

diff --git a/docs/beta/notebooks/Importing.ipynb b/docs/beta/notebooks/Importing.ipynb
@@ -50,7 +50,14 @@
     "$ pip install debuggingbook\n",
     "```\n",
     "\n",
-    "As of `debuggingbook 1.1`, this is set up such that additional required Python packages are also installed. However, also see \"Install Additional Non-Python Packages\" below.\n",
+    "As of `debuggingbook 1.1`, this is set up such that additional required Python packages are also installed.\n",
+    "However, also see \"Install Additional Non-Python Packages\" below.\n",
+    "\n",
+    "Note that after installation via `pip`, you may have to install our updated `showast` module:\n",
+    "\n",
+    "```shell\n",
+    "$ pip install 'showast@git+https://github.com/andreas-zeller/show_ast.git@andreas'\n",
+    "```\n",
     "\n",
     "Once `pip` is complete, you can import individual classes, constants, or functions from each notebook using\n",
     "\n",
@@ -114,10 +121,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2025-01-13T15:13:08.459256Z",
-     "iopub.status.busy": "2025-01-13T15:13:08.458741Z",
-     "iopub.status.idle": "2025-01-13T15:13:08.541895Z",
-     "shell.execute_reply": "2025-01-13T15:13:08.541592Z"
+     "iopub.execute_input": "2025-01-13T16:01:01.586172Z",
+     "iopub.status.busy": "2025-01-13T16:01:01.585918Z",
+     "iopub.status.idle": "2025-01-13T16:01:01.679641Z",
+     "shell.execute_reply": "2025-01-13T16:01:01.678951Z"
     },
     "slideshow": {
      "slide_type": "skip"
@@ -133,10 +140,10 @@
    "execution_count": 2,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2025-01-13T15:13:08.543555Z",
-     "iopub.status.busy": "2025-01-13T15:13:08.543450Z",
-     "iopub.status.idle": "2025-01-13T15:13:08.634832Z",
-     "shell.execute_reply": "2025-01-13T15:13:08.634545Z"
+     "iopub.execute_input": "2025-01-13T16:01:01.684000Z",
+     "iopub.status.busy": "2025-01-13T16:01:01.683512Z",
+     "iopub.status.idle": "2025-01-13T16:01:01.777141Z",
+     "shell.execute_reply": "2025-01-13T16:01:01.776792Z"
     },
     "slideshow": {
      "slide_type": "skip"
@@ -152,10 +159,10 @@
    "execution_count": 3,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2025-01-13T15:13:08.636553Z",
-     "iopub.status.busy": "2025-01-13T15:13:08.636452Z",
-     "iopub.status.idle": "2025-01-13T15:13:08.638580Z",
-     "shell.execute_reply": "2025-01-13T15:13:08.638288Z"
+     "iopub.execute_input": "2025-01-13T16:01:01.779348Z",
+     "iopub.status.busy": "2025-01-13T16:01:01.779204Z",
+     "iopub.status.idle": "2025-01-13T16:01:01.781815Z",
+     "shell.execute_reply": "2025-01-13T16:01:01.781193Z"
     },
     "slideshow": {
      "slide_type": "subslide"

diff --git a/docs/beta/notebooks/ReleaseNotes.ipynb b/docs/beta/notebooks/ReleaseNotes.ipynb
@@ -45,7 +45,13 @@
     "\n",
     "* New chapter on [Learning from Failures](Alhazen.ipynb), joining machine learning and debugging\n",
     "* Updates to `requirements.txt`, using the latest and greatest third-party modules\n",
-    "* Python 3.9 is no longer supported."
+    "* Python 3.9 is no longer supported.\n",
+    "\n",
+    "Note that after installation via `pip`, you may have to install our updated `showast` module:\n",
+    "\n",
+    "```shell\n",
+    "$ pip install 'showast@git+https://github.com/andreas-zeller/show_ast.git@andreas'\n",
+    "```"
    ]
   },
   {