|
42 | 42 | # UPSTREAM_REPO=https://github.com/datajoint/element-{ELEMENT}.git \ |
43 | 43 | # HOST_UID=$(id -u) docker compose -f docs/docker-compose.yaml up --build |
44 | 44 | # ``` |
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. |
48 | 46 | # A. Follow google styleguide e.g., |
49 | 47 | # https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html |
50 | 48 | # With typing suggestions: https://docs.python.org/3/library/typing.html |
51 | 49 | # 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 |
53 | 51 | # 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, |
56 | 53 | # A. declare a branch called gh-pages |
57 | 54 | # B. go to the your fork > settings > pages |
58 | 55 | # C. direct pages to render from the gh-pages branch at root |
|
87 | 84 | plugins: |
88 | 85 | - markdownextradata: {} |
89 | 86 | - search |
90 | | - # - redirects: # OPTIONAL REDIRECTS |
91 | | - # redirect_maps: |
92 | | - # "index.md": "getting_started.md" |
93 | 87 | - mkdocstrings: |
94 | 88 | default_handler: python |
95 | 89 | - gen-files: |
@@ -120,13 +114,12 @@ markdown_extensions: |
120 | 114 | linenums: true |
121 | 115 | - pymdownx.inlinehilite |
122 | 116 | - pymdownx.snippets |
123 | | - |
| 117 | + - pymdownx.magiclink # Displays bare URLs as links |
| 118 | + - pymdownx.tasklist: # Renders check boxes in tasks lists |
| 119 | + custom_checkbox: true |
124 | 120 | extra: |
125 | 121 | PATCH_VERSION: !ENV PATCH_VERSION |
126 | 122 | generator: false # Disable watermark |
127 | | - analytics: |
128 | | - provider: google |
129 | | - property: !ENV GOOGLE_ANALYTICS_KEY |
130 | 123 | version: |
131 | 124 | provider: mike |
132 | 125 | social: |
|
0 commit comments