-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
105 lines (97 loc) · 3.59 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
site_name: "Algorithmic Essays"
site_url: https://dsa-ou.github.io/algoesup/
repo_url: https://github.com/dsa-ou/algoesup
repo_name: dsa-ou/algoesup
copyright: Copyright (c) 2023–2024 The Open University
docs_dir: src/docs
site_dir: docs
exclude_docs: |
*toml
plugins:
- mkdocstrings:
handlers:
python:
paths: [src]
options:
docstring_style: "google"
separate_signature: true
show_signature_annotations: true
show_source: false
- mkdocs-jupyter
- open-in-new-tab
- search
watch: # folders that `mkdocs serve` will watch for changes
- src/algoesup
extra:
social: # links for the footer
- icon: fontawesome/brands/github
link: https://github.com/dsa-ou/algoesup
- icon: octicons/package-16
link: https://pypi.org/project/algoesup/
- icon: simple/deepnote
link: https://deepnote.com/workspace/lpsae-cc66-cd5cf5e4-ca6e-49d8-b6ee-dbbf202143d3/project/Algorithmic-Essays-acd23b74-5d63-4ef4-a991-3b8a049ddf6b
markdown_extensions:
- admonition # allow !!! note / warning / info / example / etc.
- attr_list # allow {.class} after text, e.g. for buttons
- smarty # curly quotes, guillemots, -- for en-dash, --- for em-dash
- pymdownx.highlight # highlight code with Pygments
- pymdownx.smartsymbols # typeset 1/4 as ¼, 1st as 1^{st}, (c) as ©, +/- as ±, etc.
- pymdownx.superfences # needed for highlighting
extra_css:
- stylesheets/extra.css # change look of admonitions
extra_javascript:
- https://unpkg.com/[email protected]/dist/tablesort.min.js
- javascripts/tablesort.js
theme:
name: material
font: false # use system font stack
features:
- content.code.copy # add copy button to code blocks
- navigation.footer # add previous/next buttons below the page
- navigation.sections # non-collapsible sections, listing their pages
# the following make navigation more confusing or require extra clicks
# - navigation.tabs # show sections in header; nav panel only shows current section
# - navigation.tabs.sticky
# - toc.integrate # show TOC in left panel, not separate right panel
icon: # icon next to repo url/name
repo: fontawesome/brands/github
admonition:
tip: material/lightbulb-on
palette:
- scheme: default # light mode
toggle:
icon: material/brightness-6
name: Switch to dark mode
- scheme: slate # dark mode
toggle:
icon: material/brightness-6
name: Switch to light mode
nav:
- Introduction:
- Home: index.md
- example-essays.md
- Get started (Deepnote): getting-started.md
- Get started (Google Colab): getting-started-google-colab.md
- Get started (M269): getting-started-m269.md
# not in the nav panel due to https://github.com/danielfrg/mkdocs-jupyter/issues/189
# - Templates:
# - Basic: essays/template-intro-programming.ipynb
# - Extended: essays/template-data-structures.ipynb
# - Examples:
# - essays/example-1-to-n.ipynb
# - essays/example-jewels.ipynb
# - essays/example-two-sum-2.ipynb
# - essays/example-two-sum-3.ipynb
- Guides:
- writing.md
- coding.ipynb
- feedback.md
- jn-platform-comparison.md
- Library:
- Reference: library.md
- Deepnote:
- Overview: deepnote.md
- How-to: deepnote-how-to.md
- deepnote-background.md
- deepnote-reference.md
- Project: https://deepnote.com/workspace/lpsae-cc66-cd5cf5e4-ca6e-49d8-b6ee-dbbf202143d3/project/Algorithmic-Essays-acd23b74-5d63-4ef4-a991-3b8a049ddf6b