Merge pull request #1 from kfrey-idm/kfrey_template

Template docs and workflows

Author: kfrey-idm

.github/workflows/mkdocs_build.yml

@@ -0,0 +1,26 @@
+name: Build docs
+
+on:
+  pull_request:
+    branches: main
+
+  # Allows manual run from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install packages
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install .[docs]
+      - name: Build static files
+        run: |
+          mkdocs build

.github/workflows/mkdocs_deploy.yml

@@ -0,0 +1,48 @@
+name: Build docs and deploy to GH Pages
+
+on:
+  push:
+    branches:
+      - 'main'
+    paths: 
+      - 'mkdocs.yml'
+      - 'docs/**'
+
+  # Allows manual run from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install packages
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install .[docs]
+      - name: Build static files
+        run: |
+          mkdocs build -d site
+      - name: Upload static files as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy-docs:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}  # Not used
+    permissions:
+      id-token: write
+      pages: write
+    needs: build-docs
+    steps:
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

docs/bib.md

@@ -0,0 +1,5 @@
+[emodpy]: https://docs.idmod.org/projects/emodpy/en/latest/index.html
+[idmtools]: https://docs.idmod.org/projects/idmtools/en/latest/index.html
+[emod-generic]: https://docs.idmod.org/projects/emod-generic/en/latest/parameter-overview.html
+[idmod]: https://www.idmod.org/
+[idm_pypi]: https://packages.idmod.org/

docs/customization/css/extra.css

@@ -0,0 +1,6 @@
+div.md-copyright__highlight
+{
+    display: flex;
+    flex-direction: row;
+    gap: 2em;
+}

docs/customization/javascripts/mathjax.js

@@ -0,0 +1,19 @@
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex"
+  }
+};
+
+document$.subscribe(() => { 
+  MathJax.startup.output.clearCache()
+  MathJax.typesetClear()
+  MathJax.texReset()
+  MathJax.typesetPromise()
+})

docs/customization/overrides/partials/copyright.html

@@ -0,0 +1,19 @@
+{# base partial from:
+github.com/squidfunk/mkdocs-material/material/templates/partials/copyright.html
+#}
+<div class="md-copyright">
+    {% if config.copyright %}
+    <div class="md-copyright__highlight">
+        {{ config.copyright }}
+        {% for link in config.extra.footer_links %}
+        <a href="{{ link.href }}" target="_blank" rel="noopener" style="TEXT-DECORATION: underline">{{ link.text }}</a>
+        {% endfor %}
+    </div>
+    {% endif %}
+    {% if not config.extra.generator == false %}
+    Made with
+    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+        Material for MkDocs
+    </a>
+    {% endif %}
+</div>