Skip to content

Commit

Permalink
Fix #8: add info to DeepNote guide (#36)
Browse files Browse the repository at this point in the history 
* Explain in quickstart guide how to expand the stack trace which is hidden by default.
* Add to README reminder to update the environment before regenerating the docs.
* Regenerate the docs (with updated versions of depenencies)

---------

Co-authored-by: Michel Wermelinger <[email protected]>
  • Loading branch information
@densnow @mwermelinger
densnow and mwermelinger committed May 31, 2024
1 parent 7457c84 commit 743aa8a
Show file tree
Hide file tree
Showing 33 changed files with 163 additions and 126 deletions.
7 changes: 4 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@ After installing `poetry`, enter `poetry install` to create the development envi

To preview the documentation that will be in GitHub Pages, enter `poetry run mkdocs serve`.

The documentation must be written in strict Markdown:
The documentation must be written in strict Markdown:
blank line before a new list; line breaks are two spaces; indentation is 4 spaces.

To build the documentation in the `docs/` folder from the `src/docs` files,
To build the documentation in the `docs/` folder from the `src/docs` files, first enter
`poetry install` to update your development environment, then
enter `poetry run mkdocs build`.
(Don't use `mkdocs gh-deploy` because it pushes untracked and other files,
(Don't use `mkdocs gh-deploy` because it pushes untracked and other files,
without giving you a chance to check what will be pushed.)

When a new version of the library is to be put on PyPI:
Expand Down
6 changes: 3 additions & 3 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@


<link rel="icon" href="/algoesup/assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>Algorithmic Essays</title>



<link rel="stylesheet" href="/algoesup/assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="/algoesup/assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="/algoesup/assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -832,7 +832,7 @@ <h1>404 - Not found</h1>
<script id="__config" type="application/json">{"base": "/algoesup/", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "/algoesup/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="/algoesup/assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="/algoesup/assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="/algoesup/js/open_in_new_tab.js"></script>

Expand Down
7 changes: 6 additions & 1 deletion docs/assets/_mkdocstrings.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,9 @@ code.doc-symbol-module {

code.doc-symbol-module::after {
content: "mod";
}
}

.doc-signature .autorefs {
color: inherit;
border-bottom: 1px dotted currentcolor;
}
29 changes: 29 additions & 0 deletions docs/assets/javascripts/bundle.1e8ae164.min.js
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions ...ts/javascripts/bundle.8fd75fb4.min.js.map → ...ts/javascripts/bundle.1e8ae164.min.js.map
View file

Large diffs are not rendered by default.

29 changes: 0 additions & 29 deletions docs/assets/javascripts/bundle.8fd75fb4.min.js
View file

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/stylesheets/main.7e359304.min.css
View file

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/stylesheets/main.7e359304.min.css.map
View file

This file was deleted.

1 change: 1 addition & 0 deletions docs/assets/stylesheets/main.bcfcd587.min.css
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/assets/stylesheets/main.bcfcd587.min.css.map
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/coding/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>Coding guide - Algorithmic Essays</title>



<link rel="stylesheet" href="../assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -2918,7 +2918,7 @@ <h2 id="final-check">Final check<a class="anchor-link" href="#final-check">¶</a
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="../assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="../js/open_in_new_tab.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/deepnote-background/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>Background - Algorithmic Essays</title>



<link rel="stylesheet" href="../assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -1106,7 +1106,7 @@ <h2 id="limitations">Limitations</h2>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="../assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="../js/open_in_new_tab.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/deepnote-how-to/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>How-to - Algorithmic Essays</title>



<link rel="stylesheet" href="../assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -1450,7 +1450,7 @@ <h3 id="format-a-code-cell">Format a code cell</h3>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="../assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="../js/open_in_new_tab.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/deepnote-reference/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@


<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>Reference - Algorithmic Essays</title>



<link rel="stylesheet" href="../assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -1571,7 +1571,7 @@ <h2 id="keyboard-shortcuts">Keyboard shortcuts</h2>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="../assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="../js/open_in_new_tab.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/deepnote/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>Overview - Algorithmic Essays</title>



<link rel="stylesheet" href="../assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -939,7 +939,7 @@ <h1 id="deepnote">Deepnote</h1>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="../assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="../js/open_in_new_tab.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/essays/example-1-to-n/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>Sum of 1 to n - Algorithmic Essays</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -2105,7 +2105,7 @@ <h2 id="concluding-remarks">Concluding remarks<a class="anchor-link" href="#conc
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="../../js/open_in_new_tab.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/essays/example-jewels/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>Jewels and Stones - Algorithmic Essays</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -2666,7 +2666,7 @@ <h2 id="5-concluding-remarks">5 Concluding remarks<a class="anchor-link" href="#
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="../../js/open_in_new_tab.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/essays/example-two-sum-2/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>Two Sum (two solutions) - Algorithmic Essays</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -2064,7 +2064,7 @@ <h2 id="5-conclusion">5 Conclusion<a class="anchor-link" href="#5-conclusion">¶
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="../../js/open_in_new_tab.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/essays/example-two-sum-3/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>Two sum (three solutions) - Algorithmic Essays</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -2661,7 +2661,7 @@ <h2 id="5-conclusion">5 Conclusion<a class="anchor-link" href="#5-conclusion">¶
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="../../js/open_in_new_tab.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/essays/template-data-structures/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.11">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">



<title>Your essay's title - Algorithmic Essays</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.7e359304.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">


<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -2076,7 +2076,7 @@ <h2 id="6-acknowledgements">6 Acknowledgements<a class="anchor-link" href="#6-ac
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../assets/javascripts/bundle.8fd75fb4.min.js"></script>
<script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>

<script src="../../js/open_in_new_tab.js"></script>

Expand Down
Loading

0 comments on commit 743aa8a

Please sign in to comment.