init mkdocs example

CUAHSI · Oct 6, 2023 · f19ddac · f19ddac
commit f19ddac
Show file tree

Hide file tree

Showing 14 changed files with 85 additions and 0 deletions.
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -0,0 +1,22 @@
+name: Publish docs via GitHub Pages
+on:
+  push
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9"]
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v3
+
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # EXTRA_PACKAGES: 
+          # GITHUB_DOMAIN: 
+          REQUIREMENTS: requirements-mkdocs.txt
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,17 @@
+propsfile
+*.bak
+*.log
+__pycache__
+.idea/
+.vscode
+
+node_modules
+build
+npm-debug.log
+.env
+.DS_Store
+.vscode/
+venv
+site
+
+debug
diff --git a/docs/cuahsi_base/cuahsi_base.md b/docs/cuahsi_base/cuahsi_base.md
@@ -0,0 +1 @@
+:::cuahsi_base.cuahsi_base
diff --git a/docs/cuahsi_base/site_element.md b/docs/cuahsi_base/site_element.md
@@ -0,0 +1 @@
+:::cuahsi_base.site_element
diff --git a/docs/cuahsi_base/utils.md b/docs/cuahsi_base/utils.md
@@ -0,0 +1 @@
+:::cuahsi_base.utils
diff --git a/docs/dsp/dsp_macros.md b/docs/dsp/dsp_macros.md
@@ -0,0 +1 @@
+::: dsp.dsp_macros
diff --git a/docs/dsp/dsp_tests.md b/docs/dsp/dsp_tests.md
@@ -0,0 +1 @@
+::: dsp.dsp
diff --git a/docs/hydroclient/hc_macros.md b/docs/hydroclient/hc_macros.md
@@ -0,0 +1 @@
+::: hydroclient.hc_macros
diff --git a/docs/hydroclient/hydroclient_tests.md b/docs/hydroclient/hydroclient_tests.md
@@ -0,0 +1 @@
+::: hydroclient.hydroclient
diff --git a/docs/hydroshare/hs_macros.md b/docs/hydroshare/hs_macros.md
@@ -0,0 +1 @@
+::: hydroshare.hs_macros
diff --git a/docs/hydroshare/hydroshare_tests.md b/docs/hydroshare/hydroshare_tests.md
@@ -0,0 +1 @@
+::: hydroshare.hydroshare
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,10 @@
+# QA-AutomationEngine Test Documentation
+
+### About
+The QA-AutomationEngine contains:
+
+> Automated test suites for multiple CUAHSI software systems, along with associated tools and infrastructure
+
+The site you are currently viewing is meant to accompany the documentation available in the [repository's Readme](https://github.com/CUAHSI/QA-AutomationEngine#readme), which contains detailed information about the QA system design and configuration as well as development guides.
+
+This static site provides detailed documentation of the tests run by the QA system, and is intended as a resource for both developers and product stakeholders, to create a clearer understanding of code coverage.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,23 @@
+site_name: CUAHSI QA Documentation
+
+theme:
+  name: "material"
+
+plugins:
+  - mkdocstrings
+
+nav:
+  - About: index.md
+  - Base:
+    - Cuahsi Base: cuahsi_base/cuahsi_base.md
+    - Site Element: cuahsi_base/site_element.md
+    - Utils: cuahsi_base/utils.md
+  - DSP: 
+    - DSP Tests: dsp/dsp_tests.md
+    - DSP Macros: dsp/dsp_macros.md
+  - Hydroshare:
+    - Hydroshare Tests: hydroshare/hydroshare_tests.md
+    - Hydroshare Macros: hydroshare/hs_macros.md
+  - Hydroclient:
+    - Hydroclient Tests: hydroclient/hydroclient_tests.md
+    - Hydroclient Macros: hydroclient/hc_macros.md
diff --git a/requirements-mkdocs.txt b/requirements-mkdocs.txt
@@ -0,0 +1,4 @@
+mkdocs>=1.3.0,<2.0.0
+mkdocstrings>=0.19.0,<1.0.0
+mkdocstrings-python>=0.7.1,<1.0.0
+mkdocs-material>=8.3.7,<9.0.0