From 78b031b74d7bb6d5f7568cb5935790301a56bcd3 Mon Sep 17 00:00:00 2001 From: Kabilar Gunalan Date: Thu, 25 May 2023 09:35:22 -0500 Subject: [PATCH 1/2] Update docs configuration --- .../workflows/u24_element_release_call.yaml | 2 -- docs/.docker/pip_requirements.txt | 4 +++- docs/mkdocs.yaml | 19 ++++++------------- 3 files changed, 9 insertions(+), 16 deletions(-) diff --git a/.github/workflows/u24_element_release_call.yaml b/.github/workflows/u24_element_release_call.yaml index fa8deba..4324cca 100644 --- a/.github/workflows/u24_element_release_call.yaml +++ b/.github/workflows/u24_element_release_call.yaml @@ -17,7 +17,6 @@ jobs: secrets: TWINE_USERNAME: ${{secrets.TWINE_TEST_USERNAME}} TWINE_PASSWORD: ${{secrets.TWINE_TEST_PASSWORD}} - GOOGLE_ANALYTICS_KEY: ${{secrets.GOOGLE_ANALYTICS_KEY}} call_u24_elements_release_alpine: if: >- github.event.workflow_run.conclusion == 'success' && github.repository_owner == 'datajoint' && !contains(github.event.workflow_run.head_branch, 'test') @@ -27,4 +26,3 @@ jobs: secrets: TWINE_USERNAME: ${{secrets.TWINE_USERNAME}} TWINE_PASSWORD: ${{secrets.TWINE_PASSWORD}} - GOOGLE_ANALYTICS_KEY: ${{secrets.GOOGLE_ANALYTICS_KEY}} diff --git a/docs/.docker/pip_requirements.txt b/docs/.docker/pip_requirements.txt index 9a1b23f..ae44fb5 100644 --- a/docs/.docker/pip_requirements.txt +++ b/docs/.docker/pip_requirements.txt @@ -7,4 +7,6 @@ mdx-truly-sane-lists mkdocs-gen-files mkdocs-literate-nav mkdocs-exclude-search -mkdocs-markdownextradata-plugin \ No newline at end of file +mkdocs-markdownextradata-plugin +mkdocs-jupyter +mkdocs-section-index \ No newline at end of file diff --git a/docs/mkdocs.yaml b/docs/mkdocs.yaml index 74a68e6..9ea2cb1 100644 --- a/docs/mkdocs.yaml +++ b/docs/mkdocs.yaml @@ -42,17 +42,14 @@ nav: # UPSTREAM_REPO=https://github.com/datajoint/element-{ELEMENT}.git \ # HOST_UID=$(id -u) docker compose -f docs/docker-compose.yaml up --build # ``` -# 02. Site analytics depend on a local environment variable GOOGLE_ANALYTICS_KEY -# You can find this in LastPass or declare with any string to suprress errors -# 03. The API section will pull docstrings. +# 02. The API section will pull docstrings. # A. Follow google styleguide e.g., # https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html # With typing suggestions: https://docs.python.org/3/library/typing.html # B. To pull a specific workflow fork, change ./docs/src/api/make_pages.py#L19 -# 04. To see your fork of the workflow-{element} in this render, change the +# 03. To see your fork of the workflow-{element} in this render, change the # URL in ./docs/src/api/make_pages.py#L19 to your fork. -# 05. For redirecting options For redirect options, see 'redirects' below. -# 06. To deploy this site on your fork, +# 04. To deploy this site on your fork, # A. declare a branch called gh-pages # B. go to the your fork > settings > pages # C. direct pages to render from the gh-pages branch at root @@ -87,9 +84,6 @@ theme: plugins: - markdownextradata: {} - search - # - redirects: # OPTIONAL REDIRECTS - # redirect_maps: - # "index.md": "getting_started.md" - mkdocstrings: default_handler: python - gen-files: @@ -120,13 +114,12 @@ markdown_extensions: linenums: true - pymdownx.inlinehilite - pymdownx.snippets - + - pymdownx.magiclink # Displays bare URLs as links + - pymdownx.tasklist: # Renders check boxes in tasks lists + custom_checkbox: true extra: PATCH_VERSION: !ENV PATCH_VERSION generator: false # Disable watermark - analytics: - provider: google - property: !ENV GOOGLE_ANALYTICS_KEY version: provider: mike social: From 096a314aac94b5dcfaa87e7ea30e781c2cc2761f Mon Sep 17 00:00:00 2001 From: Kabilar Gunalan Date: Thu, 25 May 2023 09:39:47 -0500 Subject: [PATCH 2/2] Update changelog --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 41d68ed..33e5e75 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,9 +3,10 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention. -## [0.5.4] - 2023-05-14 +## [0.5.4] - 2023-05-25 + Fix - DANDI URL for uploads where `staging=False`. ++ Fix - Docs to remote Google Analytics Key and add Markdown extensions ## [0.5.3] - 2023-05-11