Merge pull request #112 from CHIMEFRB/docs-for-handbook

docs: update mkdocs config + ci/cd

Author: tjzegmott

.github/workflows/docs.yml

@@ -11,31 +11,8 @@ jobs:
   mkdocs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.9
-
-      - name: Load cached venv
-        id: cached-poetry-dependencies
-        uses: actions/cache@v3
-        with:
-          path: |
-            ~/.cache/pypoetry
-          key: poetry-${{ runner.os }}-${{ hashFiles('poetry.lock') }}
-
-      - name: Installation
-        run: |
-          pip install poetry
-          poetry install --without dev
-
-      - name: Create docs
-        run: poetry run mkdocs gh-deploy --force
-
       - name: Build chimefrb/handbook
-        uses: peter-evans/repository-dispatch@v2
+        uses: peter-evans/repository-dispatch@v3
         with:
           token: ${{ secrets.BUILD_HANDBOOK_TOKEN }}
           repository: chimefrb/handbook

mkdocs.yml

@@ -1,77 +1,5 @@
 ---
-site_name: Datatrail CLI
-site_author: Tarik Zegmott
-site_description: "Datatrail CLI"
-repo_name: chimefrb/datatrail-cli
-repo_url: "https://github.com/chimefrb/datatrail-cli"
-copyright: Copyright © 2016 - 2023 CHIME/FRB Collaboration
-
-theme:
-  name: material
-  palette:
-    scheme: slate
-    primary: deep purple
-    accent: yellow
-  font:
-    text: Roboto
-    code: Roboto Mono
-  language: en
-  features:
-    - navigation.expand
-    - navigation.top
-    - navigation.instant
-    - navigation.tabs
-    - navigation.tabs.sticky
-    - content.code.annotate
-
-plugins:
-  - search
-  - mkdocstrings
-  - termynal
-
-# Extensions
-markdown_extensions:
-  - admonition
-  - abbr
-  - attr_list
-  - def_list
-  - footnotes
-  - mkdocs-click
-  - md_in_html
-  - meta
-  - toc:
-      permalink: true
-  - pymdownx.arithmatex:
-      generic: true
-  - pymdownx.betterem:
-      smart_enable: all
-  - pymdownx.caret
-  - pymdownx.critic
-  - pymdownx.details
-  - pymdownx.emoji
-  - pymdownx.highlight:
-      use_pygments: true
-      linenums_style: pymdownx.inline
-  - pymdownx.inlinehilite
-  - pymdownx.keys
-  - pymdownx.magiclink:
-      repo_url_shorthand: true
-      user: squidfunk
-      repo: mkdocs-material
-  - pymdownx.mark
-  - pymdownx.smartsymbols
-  - pymdownx.snippets:
-      check_paths: true
-  - pymdownx.superfences:
-      custom_fences:
-        - name: mermaid
-          class: mermaid
-          format: "!!python/name:pymdownx.superfences.fence_code_format"
-  - pymdownx.tabbed:
-      alternate_style: true
-  - pymdownx.tasklist:
-      custom_checkbox: true
-  - pymdownx.tilde
+site_name: datatrail-cli
 
 nav:
   - Home: