Skip to content

Commit 2dcca99

Browse files
committed
Update docs configuration
1 parent e4358a5 commit 2dcca99

File tree

3 files changed

+6
-13
lines changed

3 files changed

+6
-13
lines changed

.github/workflows/u24_element_release_call.yml

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,5 +26,4 @@ jobs:
2726
secrets:
2827
TWINE_USERNAME: ${{secrets.TWINE_USERNAME}}
2928
TWINE_PASSWORD: ${{secrets.TWINE_PASSWORD}}
30-
GOOGLE_ANALYTICS_KEY: ${{secrets.GOOGLE_ANALYTICS_KEY}}
3129

docs/docker-compose.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ services:
1414
- PACKAGE
1515
- UPSTREAM_REPO
1616
- MODE
17-
- GOOGLE_ANALYTICS_KEY
1817
- PATCH_VERSION
1918
volumes:
2019
- ../docs:/main/docs

docs/mkdocs.yaml

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,17 +54,14 @@ nav:
5454
# UPSTREAM_REPO=https://github.com/datajoint/element-{ELEMENT}.git \
5555
# HOST_UID=$(id -u) docker compose -f docs/docker-compose.yaml up --build
5656
# ```
57-
# 02. Site analytics depend on a local environment variable GOOGLE_ANALYTICS_KEY
58-
# You can find this in LastPass or declare with any string to suppress errors
59-
# 03. The API section will pull docstrings.
57+
# 02. The API section will pull docstrings.
6058
# A. Follow google style guide e.g.,
6159
# https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
6260
# With typing suggestions: https://docs.python.org/3/library/typing.html
6361
# B. To pull a specific workflow fork, change ./docs/src/api/make_pages.py#L19
64-
# 04. To see your fork of the workflow-{element} in this render, change the
62+
# 03. To see your fork of the workflow-{element} in this render, change the
6563
# URL in ./docs/src/api/make_pages.py#L19 to your fork.
66-
# 05. For redirecting options For redirect options, see 'redirects' below.
67-
# 06. To deploy this site on your fork,
64+
# 04. To deploy this site on your fork,
6865
# A. declare a branch called gh-pages
6966
# B. go to the your fork > settings > pages
7067
# C. direct pages to render from the gh-pages branch at root
@@ -141,13 +138,12 @@ markdown_extensions:
141138
- pymdownx.inlinehilite
142139
- pymdownx.snippets
143140
- footnotes
144-
141+
- pymdownx.magiclink # Displays bare URLs as links
142+
- pymdownx.tasklist: # Renders check boxes in tasks lists
143+
custom_checkbox: true
145144
extra:
146145
PATCH_VERSION: !ENV PATCH_VERSION
147146
generator: false # Disable watermark
148-
analytics:
149-
provider: google
150-
property: !ENV GOOGLE_ANALYTICS_KEY
151147
version:
152148
provider: mike
153149
social:

0 commit comments

Comments
 (0)