Skip to content

Commit

Permalink
Merge pull request #84 from kabilar/main
Browse files Browse the repository at this point in the history
Fix docs
  • Loading branch information
dimitri-yatsenko authored May 25, 2023
2 parents 51b9bdc + 096a314 commit 37a4051
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 15 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 3 additions & 1 deletion docs/.docker/pip_requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ mdx-truly-sane-lists
mkdocs-gen-files
mkdocs-literate-nav
mkdocs-exclude-search
mkdocs-markdownextradata-plugin
mkdocs-markdownextradata-plugin
mkdocs-jupyter
mkdocs-section-index
19 changes: 6 additions & 13 deletions docs/mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 suppress 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
Expand Down Expand Up @@ -87,9 +84,6 @@ theme:
plugins:
- markdownextradata: {}
- search
# - redirects: # OPTIONAL REDIRECTS
# redirect_maps:
# "index.md": "getting_started.md"
- mkdocstrings:
default_handler: python
- gen-files:
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 37a4051

Please sign in to comment.