Skip to content

Commit 78b031b

Browse files
committed
Update docs configuration
1 parent 8a7cefe commit 78b031b

File tree

3 files changed

+9
-16
lines changed

3 files changed

+9
-16
lines changed

.github/workflows/u24_element_release_call.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ jobs:
1717
secrets:
1818
TWINE_USERNAME: ${{secrets.TWINE_TEST_USERNAME}}
1919
TWINE_PASSWORD: ${{secrets.TWINE_TEST_PASSWORD}}
20-
GOOGLE_ANALYTICS_KEY: ${{secrets.GOOGLE_ANALYTICS_KEY}}
2120
call_u24_elements_release_alpine:
2221
if: >-
2322
github.event.workflow_run.conclusion == 'success' && github.repository_owner == 'datajoint' && !contains(github.event.workflow_run.head_branch, 'test')
@@ -27,4 +26,3 @@ jobs:
2726
secrets:
2827
TWINE_USERNAME: ${{secrets.TWINE_USERNAME}}
2928
TWINE_PASSWORD: ${{secrets.TWINE_PASSWORD}}
30-
GOOGLE_ANALYTICS_KEY: ${{secrets.GOOGLE_ANALYTICS_KEY}}

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 & 13 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 suprress 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
- gen-files:
@@ -120,13 +114,12 @@ markdown_extensions:
120114
linenums: true
121115
- pymdownx.inlinehilite
122116
- pymdownx.snippets
123-
117+
- pymdownx.magiclink # Displays bare URLs as links
118+
- pymdownx.tasklist: # Renders check boxes in tasks lists
119+
custom_checkbox: true
124120
extra:
125121
PATCH_VERSION: !ENV PATCH_VERSION
126122
generator: false # Disable watermark
127-
analytics:
128-
provider: google
129-
property: !ENV GOOGLE_ANALYTICS_KEY
130123
version:
131124
provider: mike
132125
social:

0 commit comments

Comments
 (0)