No signature for magics; Update pyproject toml

- Update library.md algoesup.magics options to not show signature - Change mkdocs-jupyter version in pyproject.toml (`poetry run mkdocs serve` was failing with previous version on my system)
dsa-ou · Feb 28, 2024 · 83628d4 · 83628d4
1 parent 1952e04
commit 83628d4
Show file tree

Hide file tree

Showing 8 changed files with 61 additions and 47 deletions.
diff --git a/Deepnote/Dockerfile b/Deepnote/Dockerfile
@@ -1,3 +1,3 @@
 FROM python:3.10
 
-RUN pip install matplotlib==3.8.0 pytype==2023.12.8 ruff==0.1.8 allowed==1.3
+RUN pip install matplotlib==3.8.0 pytype==2023.12.8 ruff==0.1.8 allowed algoesup
diff --git a/docs/library/index.html b/docs/library/index.html
@@ -1569,14 +1569,14 @@ <h3 id="algoesup.magics.allowed" class="doc doc-heading">
 
 
 </h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="n">allowed</span><span class="p">(</span><span class="n">line</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="n">allowed</span>
 </code></pre></div>
 
   <div class="doc doc-contents ">
 
-      <p>Activate/deactivate the <code>pytype</code> linter.</p>
-<p>This magic command controls the activation state of the <code>allowed</code> linter within
-the ipython environment. It can be toggled on or off, or queried for its
+      <p>Activate/deactivate the <code>allowed</code> linter.</p>
+<p>This ipython magic command controls the activation state of the <code>allowed</code> linter 
+within the ipython environment. It can be toggled on or off, or queried for its
 current state.</p>
 
 
@@ -1604,7 +1604,7 @@ <h3 id="algoesup.magics.pytype" class="doc doc-heading">
 
 
 </h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="n">pytype</span><span class="p">(</span><span class="n">line</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="n">pytype</span>
 </code></pre></div>
 
   <div class="doc doc-contents ">
@@ -1639,14 +1639,14 @@ <h3 id="algoesup.magics.ruff" class="doc doc-heading">
 
 
 </h3>
-<div class="doc-signature highlight"><pre><span></span><code><span class="n">ruff</span><span class="p">(</span><span class="n">line</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
+<div class="doc-signature highlight"><pre><span></span><code><span class="n">ruff</span>
 </code></pre></div>
 
   <div class="doc doc-contents ">
 
       <p>Activate/deactivate the <code>ruff</code> linter.</p>
 <p>This ipython magic command controls the activation state of the <code>ruff</code> linter within
-the interactive environment. It can be toggled on or off, or queried for its
+the ipython environment. It can be toggled on or off, or queried for its
 current state.</p>
 
 

diff --git a/docs/search/search_index.json b/docs/search/search_index.json
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
@@ -2,82 +2,82 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://dsa-ou.github.io/algoesup/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/deepnote-background/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/deepnote-how-to/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/deepnote-reference/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/deepnote/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/example-essays/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/feedback/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/getting-started/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/library/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/writing/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/essays/example-1-to-n/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/essays/example-jewels/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/essays/example-two-sum-2/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/essays/example-two-sum-3/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/essays/template-data-structures/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://dsa-ou.github.io/algoesup/essays/template-intro-programming/</loc>
-         <lastmod>2024-02-27</lastmod>
+         <lastmod>2024-02-28</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -34,7 +34,7 @@ pytype = {version = ">=2023.04.27", markers = "platform_system != 'Windows'"}
 mkdocs = "^1.5.3"
 mkdocs-material = "^9.5.11"
 mkdocstrings = { version = "^0.24.0", extras = ["python"] }
-mkdocs-jupyter = "^0.24.6"
+mkdocs-jupyter = "^0.24.0"
 mkdocs-open-in-new-tab = "^1.0.3"
 
 [build-system]

diff --git a/src/docs/library.md b/src/docs/library.md
@@ -28,6 +28,7 @@ The `algoesup` library provides support for testing, timing and linting code.
     options:
       heading_level: 3
       show_root_toc_entry: false
+      show_signature: false
       members:
       - allowed
       - pytype