diff --git a/Deepnote/algoesup.py b/Deepnote/algoesup.py index d092e5a..b7c9c49 100644 --- a/Deepnote/algoesup.py +++ b/Deepnote/algoesup.py @@ -20,10 +20,11 @@ def test(function: Callable, test_table: list) -> None: """Test the function with the test_table. Report failed tests. - Preconditions: each element of test_table is a list or tuple with - - a string (the test case name) - - one or more values (the inputs to the function) - - the expected output value + **Preconditions**: each element of test_table is a list or tuple with + + - a string (the test case name) + - one or more values (the inputs to the function) + - the expected output value """ print(f"Testing {function.__name__}:") for test_case in test_table: @@ -234,7 +235,7 @@ def show_ruff_json(checker: str, output: str, filename: str) -> None: msg = error["message"] if error["fix"]: msg += f". Suggested fix: {error['fix']['message']}" - md.append(f"- {line}: \[[{code}]({url})\] {msg}") + md.append(rf"- {line}: \[[{code}]({url})\] {msg}") display_markdown("\n".join(md), raw=True) @@ -249,7 +250,7 @@ def show_pytype_errors(checker: str, output: str, filename: str) -> None: msg = m.group(2) code = m.group(3) md.append( - f"- {line}:{msg}\[[{code}](https://google.github.io/pytype/errors.html#{code})\]" + rf"- {line}:{msg}\[[{code}](https://google.github.io/pytype/errors.html#{code})\]" ) if len(md) > 1: display_markdown("\n".join(md), raw=True) diff --git a/README.md b/README.md index 5cfb31a..530f8d6 100644 --- a/README.md +++ b/README.md @@ -33,13 +33,10 @@ python3.10 -m venv venv pip install --upgrade pip pip install -r requirements.txt ``` -To preview locally the documentation that will be in GitHub Pages, follow -[this guidance](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). -The Jekyll installation instructions include how to install Ruby. -Bundler is usually automatically installed during the Ruby installation. +To preview locally the documentation that will be in GitHub Pages, enter `mkdocs serve`. -GitHub recommends to regularly do `bundle update github-pages` to ensure that -the local site preview looks like on GitHub Pages. +The documentation must be written in strict Markdown: +blank line before a new list; break lines with two spaces; indent with 4 spaces. After accepting a commit to folder `Deepnote/`, the owners will upload the updated files to the Deepnote project linked above. diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index f1f4742..0000000 --- a/docs/Gemfile +++ /dev/null @@ -1,10 +0,0 @@ -# Copied from https://github.com/just-the-docs/just-the-docs-template/blob/main/Gemfile - -source "https://rubygems.org" - -gem "jekyll", "~> 4.3.3" # installed by `gem jekyll` -# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 - -# gem "just-the-docs", "0.7.0" # pinned to the current release -gem "just-the-docs" # always download the latest release -gem "json", "~> 2.7" diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock deleted file mode 100644 index 6ce42e6..0000000 --- a/docs/Gemfile.lock +++ /dev/null @@ -1,103 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - addressable (2.8.6) - public_suffix (>= 2.0.2, < 6.0) - colorator (1.1.0) - concurrent-ruby (1.2.3) - em-websocket (0.5.3) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0) - eventmachine (1.2.7) - ffi (1.16.3) - forwardable-extended (2.6.0) - google-protobuf (3.25.2) - google-protobuf (3.25.2-aarch64-linux) - google-protobuf (3.25.2-arm64-darwin) - google-protobuf (3.25.2-x86-linux) - google-protobuf (3.25.2-x86_64-darwin) - google-protobuf (3.25.2-x86_64-linux) - http_parser.rb (0.8.0) - i18n (1.14.1) - concurrent-ruby (~> 1.0) - jekyll (4.3.3) - addressable (~> 2.4) - colorator (~> 1.0) - em-websocket (~> 0.5) - i18n (~> 1.0) - jekyll-sass-converter (>= 2.0, < 4.0) - jekyll-watch (~> 2.0) - kramdown (~> 2.3, >= 2.3.1) - kramdown-parser-gfm (~> 1.0) - liquid (~> 4.0) - mercenary (>= 0.3.6, < 0.5) - pathutil (~> 0.9) - rouge (>= 3.0, < 5.0) - safe_yaml (~> 1.0) - terminal-table (>= 1.8, < 4.0) - webrick (~> 1.7) - jekyll-include-cache (0.2.1) - jekyll (>= 3.7, < 5.0) - jekyll-sass-converter (3.0.0) - sass-embedded (~> 1.54) - jekyll-seo-tag (2.8.0) - jekyll (>= 3.8, < 5.0) - jekyll-watch (2.2.1) - listen (~> 3.0) - json (2.7.1) - just-the-docs (0.7.0) - jekyll (>= 3.8.5) - jekyll-include-cache - jekyll-seo-tag (>= 2.0) - rake (>= 12.3.1) - kramdown (2.4.0) - rexml - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) - liquid (4.0.4) - listen (3.8.0) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.4.0) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - public_suffix (5.0.4) - rake (13.1.0) - rb-fsevent (0.11.2) - rb-inotify (0.10.1) - ffi (~> 1.0) - rexml (3.2.6) - rouge (4.2.0) - safe_yaml (1.0.5) - sass-embedded (1.69.5-aarch64-linux-gnu) - google-protobuf (~> 3.23) - sass-embedded (1.69.5-arm-linux-gnueabihf) - google-protobuf (~> 3.23) - sass-embedded (1.69.5-arm64-darwin) - google-protobuf (~> 3.23) - sass-embedded (1.69.5-x86-linux-gnu) - google-protobuf (~> 3.23) - sass-embedded (1.69.5-x86_64-darwin) - google-protobuf (~> 3.23) - sass-embedded (1.69.5-x86_64-linux-gnu) - google-protobuf (~> 3.23) - terminal-table (3.0.2) - unicode-display_width (>= 1.1.1, < 3) - unicode-display_width (2.5.0) - webrick (1.8.1) - -PLATFORMS - aarch64-linux - arm-linux - arm64-darwin - x86-linux - x86_64-darwin - x86_64-linux - -DEPENDENCIES - jekyll (~> 4.3.3) - json (~> 2.7) - just-the-docs - -BUNDLED WITH - 2.5.4 diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index b3aefe7..0000000 --- a/docs/_config.yml +++ /dev/null @@ -1,39 +0,0 @@ -title: Algorithmic Essays -description: -theme: just-the-docs -url: https://dsa-ou.github.io/algoesup/ - -nav_external_links: - - title: GitHub repository - url: https://github.com/dsa-ou/algoesup - opens_in_new_tab: true - - title: Deepnote project - url: https://deepnote.com/workspace/lpsae-cc66-cd5cf5e4-ca6e-49d8-b6ee-dbbf202143d3/project/Algorithmic-Essays-acd23b74-5d63-4ef4-a991-3b8a049ddf6b - opens_in_new_tab: true - -callouts: - highlight-yellow: - color: yellow - important: - title: Important - color: blue - note: - title: Note - color: green - warning: - title: Warning - color: red - highlight-purple: - color: purple - -callouts_opacity: 0.06 - -enable_copy_code_button: true - -# New configuration option, defined in _layouts/default.html: -# open external sites in new browser tabs, to not lose guidance context. -all_external_links_new_tab: true - -# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define -# algoesup color scheme defined in _sass/color_schemes/algoesup.scss -color_scheme: algoesup \ No newline at end of file diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml deleted file mode 100644 index 673357b..0000000 --- a/docs/_data/nav.yml +++ /dev/null @@ -1,98 +0,0 @@ -- title: "Home" - url: "/" - -- title: "Getting started" - url: getting-started - -- title: "Example essays" - url: example-essays - children: - -- title: "Deepnote" - url: deepnote - children: - - title: "How-to guides" - url: deepnote-how-to - children: - - title: "Account operations" - url: deepnote-how-to#account-operations - - title: "Workspace operations" - url: deepnote-how-to#workspace-operations - - title: "Project operations" - url: deepnote-how-to#project-operations - - title: "Notebook operations" - url: deepnote-how-to#notebook-operations - - - title: "Background" - url: deepnote-background - children: - - title: "Organisation" - url: deepnote-background#organisation - - title: "Deepnote vs Classic Notebook" - url: deepnote-background#deepnote-vs-classic-notebook - - title: "Collaboration" - url: deepnote-background#collaboration - - title: "Limitations" - url: deepnote-background#limitations - - - title: "Reference" - url: deepnote-reference - children: - - title: "Workspace interface" - url: deepnote-reference#workspace-interface - - title: "Project interface" - url: deepnote-reference#project-interface - - title: "Notebooks" - url: deepnote-reference#notebooks - - title: "Access levels" - url: deepnote-reference#access-levels - - title: "Cells" - url: deepnote-reference#cells - - title: "Terminal" - url: deepnote-reference#terminal - - title: "Environment" - url: deepnote-reference#environment - - title: "Real-time collaboration" - url: deepnote-reference#real-time-collaboration - - title: "Asynchronous collaboration" - url: deepnote-reference#asynchronous-collaboration - - title: "Command palette" - url: deepnote-reference#command-palette - - title: "Members" - url: deepnote-reference#members - - title: "Markdown cheat sheet" - url: deepnote-reference#markdown-cheat-sheet - - title: "Keyboard shortcuts" - url: deepnote-reference#keyboard-shortcuts - -- title: "Writing guide" - url: writing - children: - - title: "Problem" - url: writing#problem - - title: "Text" - url: writing#text - - title: "Structure" - url: writing#structure - - title: "Algorithms" - url: writing#algorithms - - title: "Code" - url: writing#code - - title: "Performance analysis" - url: writing#performance-analysis - - title: "Final check" - url: writing#final-check - - title: "Further reading" - url: writing#further-reading - -- title: "Feedback guide" - url: feedback - children: - - title: "Asking for feedback" - url: feedback#asking-for-feedback - - title: "Giving feedback" - url: feedback#giving-feedback - - title: "Acting on feedback" - url: feedback#acting-on-feedback - - title: "Crediting feedback" - url: feedback#crediting-feedback diff --git a/docs/_includes/components/site_nav.html b/docs/_includes/components/site_nav.html deleted file mode 100644 index cea72e2..0000000 --- a/docs/_includes/components/site_nav.html +++ /dev/null @@ -1,57 +0,0 @@ - \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html deleted file mode 100644 index 10179a9..0000000 --- a/docs/_layouts/default.html +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: table_wrappers ---- - - - - -{% include head.html %} -
- Skip to main content - {% include icons/icons.html %} - {% include components/sidebar.html %} -