Skip to content

Commit 8d3d133

Browse files
committed
Update docs configuration
1 parent 3dc1213 commit 8d3d133

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

docs/.docker/pip_requirements.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ mdx-truly-sane-lists
77
mkdocs-gen-files
88
mkdocs-literate-nav
99
mkdocs-exclude-search
10-
mkdocs-markdownextradata-plugin
10+
mkdocs-markdownextradata-plugin
11+
mkdocs-jupyter
12+
mkdocs-section-index

docs/mkdocs.yaml

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,14 @@ nav:
4242
# UPSTREAM_REPO=https://github.com/datajoint/element-{ELEMENT}.git \
4343
# HOST_UID=$(id -u) docker compose -f docs/docker-compose.yaml up --build
4444
# ```
45-
# 02. Site analytics depend on a local environment variable GOOGLE_ANALYTICS_KEY
46-
# You can find this in LastPass or declare with any string to suppress errors
47-
# 03. The API section will pull docstrings.
45+
# 02. The API section will pull docstrings.
4846
# A. Follow google styleguide e.g.,
4947
# https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
5048
# With typing suggestions: https://docs.python.org/3/library/typing.html
5149
# B. To pull a specific workflow fork, change ./docs/src/api/make_pages.py#L19
52-
# 04. To see your fork of the workflow-{element} in this render, change the
50+
# 03. To see your fork of the workflow-{element} in this render, change the
5351
# URL in ./docs/src/api/make_pages.py#L19 to your fork.
54-
# 05. For redirecting options For redirect options, see 'redirects' below.
55-
# 06. To deploy this site on your fork,
52+
# 04. To deploy this site on your fork,
5653
# A. declare a branch called gh-pages
5754
# B. go to the your fork > settings > pages
5855
# C. direct pages to render from the gh-pages branch at root
@@ -87,9 +84,6 @@ theme:
8784
plugins:
8885
- markdownextradata: {}
8986
- search
90-
# - redirects: # OPTIONAL REDIRECTS
91-
# redirect_maps:
92-
# "index.md": "getting_started.md"
9387
- mkdocstrings:
9488
default_handler: python
9589
handlers:
@@ -127,7 +121,9 @@ markdown_extensions:
127121
- pymdownx.inlinehilite
128122
- pymdownx.snippets
129123
- footnotes
130-
124+
- pymdownx.magiclink # Displays bare URLs as links
125+
- pymdownx.tasklist: # Renders check boxes in tasks lists
126+
custom_checkbox: true
131127
extra:
132128
PATCH_VERSION: !ENV PATCH_VERSION
133129
generator: false # Disable watermark

0 commit comments

Comments
 (0)