code review updates

Author: A-Baji

.github/workflows/development.yaml

@@ -146,6 +146,7 @@ jobs:
           asset_path: ${{env.PKG_SDIST_PATH}}
           asset_name: pip-${{env.SDIST_PKG_NAME}}-${{env.PKG_VERSION}}.tar.gz
           asset_content_type: application/gzip
+  # Open Source documentation deploy workflow
   deploy-docs:
     if: github.event_name == 'push'
     needs: build
@@ -155,16 +156,5 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material mkdocs-redirects mkdocstrings mkdocstrings-python # mike
+      - run: pip install mkdocs-material mkdocs-redirects mkdocstrings mkdocstrings-python
       - run: mkdocs gh-deploy --force --config-file ./docs/mkdocs.yml
-      # Mike workflow - replaces line 157. Must enable mike on line 156.
-      # - run: |
-      #     git fetch origin gh-pages --depth=1
-      #     git config user.name {GITHUB USER}
-      #     git config user.email {GITHUB EMAIL}
-
-      #     # Only run the first time:
-      #     mike delete --all
-
-      #     mike deploy --push --force --update-aliases {VERSION} latest
-      #     mike set-default --push latest

docs/docker-compose-docs-serve.yaml

@@ -1,4 +1,5 @@
 # docker-compose -f docs/docker-compose-docs-serve.yaml up --build
+# navigate to http://localhost/
 version: "2.4"
 services:
   docs:
@@ -10,12 +11,12 @@ services:
     volumes:
       - ..:/main
     ports:
-      - 8080:8080
+      - 80:80
     command:
       - bash
       - -c
       - |
         pwd
         mkdocs --version
-        mkdocs serve --config-file ./docs/mkdocs.yml -a 0.0.0.0:8080
-        # tail -f /dev/null
+        mkdocs serve --config-file ./docs/mkdocs.yml -a 0.0.0.0:80
+        # tail -f /dev/null

docs/docs.dockerfile

@@ -1,5 +1,8 @@
-FROM python:latest
+FROM python:slim
 
 WORKDIR /main
-COPY . /main
+COPY ./docs /main
+COPY ./element_array_ephys /main
+COPY requirements.txt /main
+COPY setup.py /main
 RUN pip install mkdocs-material mkdocs-redirects mkdocstrings mkdocstrings-python

docs/mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: Element Array Ephys
-repo_url: https://github.com/A-Baji/element-array-ephys
-repo_name: A-Baji/element-array-ephys
+repo_url: https://github.com/datajoint/element-array-ephys
+repo_name: datajoint/element-array-ephys
 docs_dir: ./src/
 
 theme:
@@ -23,7 +23,7 @@ theme:
         name: Switch to light mode
 
 nav:
-  - Element Array Ephys: index.md
+  - Element Array Ephys: getting_started/index.md
   - Getting Started:
       - Installation: getting_started/index.md
       - Set Up: getting_started/setup.md

docs/overrides/main.html

@@ -0,0 +1,33 @@
+{% set class = "md-nav md-nav--primary" %}
+{% if "navigation.tabs" in features %}
+{% set class = class ~ " md-nav--lifted" %}
+{% endif %}
+{% if "toc.integrate" in features %}
+{% set class = class ~ " md-nav--integrated" %}
+{% endif %}
+<nav class="{{ class }}" aria-label="{{ lang.t('nav.title') }}" data-md-level="0">
+    <label class="md-nav__title" for="__drawer">
+        <a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ config.site_name | e }}"
+            class="md-nav__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo">
+            {% include "partials/logo.html" %}
+        </a>
+        {#-
+        Add DataJoint home link to navigation header, otherwise unchanged
+        -#}
+        <a href="https://www.datajoint.org/" title="DataJoint">
+            ⬅ Home
+        </a>
+    </label>
+    {% if config.repo_url %}
+    <div class="md-nav__source">
+        {% include "partials/source.html" %}
+    </div>
+    {% endif %}
+    <ul class="md-nav__list" data-md-scrollfix>
+        {% for nav_item in nav %}
+        {% set path = "__nav_" ~ loop.index %}
+        {% set level = 1 %}
+        {% include "partials/nav-item.html" %}
+        {% endfor %}
+    </ul>
+</nav>