Documentation update.

edaa-org · Feb 21, 2024 · 27d975c · 27d975c
1 parent cab58d5
commit 27d975c
Show file tree

Hide file tree

Showing 24 changed files with 1,066 additions and 432 deletions.
diff --git a/.btd.yml b/.btd.yml
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -10,7 +10,6 @@ updates:
       - Dependencies
     reviewers:
       - Paebbels
-      - Umarcor
     schedule:
       interval: "daily"    # Checks on Monday trough Friday.
 
@@ -24,6 +23,5 @@ updates:
       - Dependencies
     reviewers:
       - Paebbels
-      - Umarcor
     schedule:
       interval: "weekly"
diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml
@@ -4,123 +4,183 @@ on:
   push:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * 5'
+# Every Friday at 22:00 - rerun pipeline to check for dependency-based issues
+    - cron: '0 22 * * 5'
 
 jobs:
-
-  Params:
-    uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
+  UnitTestingParams:
+    uses: pyTooling/Actions/.github/workflows/Parameters.yml@r1
     with:
       name: pyEDAA.Reports
+      python_version_list: "3.8 3.9 3.10 3.11 3.12 pypy-3.8 pypy-3.9 pypy-3.10"
+#      disable_list: "windows:pypy-3.8 windows:pypy-3.9 windows:pypy-3.10"
 
   UnitTesting:
-    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
+    uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@r1
     needs:
-      - Params
+      - UnitTestingParams
     with:
-      jobs: ${{ needs.Params.outputs.python_jobs }}
-      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}
+      jobs: ${{ needs.UnitTestingParams.outputs.python_jobs }}
+      requirements: "-r tests/unit/requirements.txt"
+      pacboy: "msys/git"
+      unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
+      coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
 
-  Coverage:
-    uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@dev
+  StaticTypeCheck:
+    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@r1
     needs:
-      - Params
+      - UnitTestingParams
     with:
-      python_version: ${{ needs.Params.outputs.python_version }}
-      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
-    secrets:
-      codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      commands: |
+        touch pyEDAA/__init__.py
+        mypy --html-report htmlmypy -p pyEDAA.Reports
+      html_report: 'htmlmypy'
+      html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
 
-  StaticTypeCheck:
-    uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@dev
+  DocCoverage:
+    uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@r1
     needs:
-      - Params
+      - UnitTestingParams
     with:
-      python_version: ${{ needs.Params.outputs.python_version }}
-      requirements: '-r tests/requirements.txt'
-      commands: |
-        cd pyEDAA
-        mypy --html-report ../htmlmypy -p Reports
-      html_artifact: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      directory: sphinx_reports
+#      fail_below: 70
 
-  PublishTestResults:
-    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
+  Package:
+    uses: pyTooling/Actions/.github/workflows/Package.yml@r1
     needs:
+      - UnitTestingParams
       - UnitTesting
+    with:
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
 
-  Package:
-    uses: pyTooling/Actions/.github/workflows/Package.yml@dev
+  PublishCoverageResults:
+    uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@r1
     needs:
-      - Params
-      - Coverage
+      - UnitTestingParams
+      - UnitTesting
     with:
-      python_version: ${{ needs.Params.outputs.python_version }}
-      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
+#      coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
+#      coverage_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}
+      coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
+      coverage_html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
+    secrets:
+      codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
 
-  Release:
-    uses: pyTooling/Actions/.github/workflows/Release.yml@dev
-    if: startsWith(github.ref, 'refs/tags')
+  PublishTestResults:
+    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r1
     needs:
+      - UnitTestingParams
       - UnitTesting
-      - Coverage
-      - StaticTypeCheck
-      - Package
+    with:
+      merged_junit_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
 
-  PublishOnPyPI:
-    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
-    if: startsWith(github.ref, 'refs/tags')
+  IntermediateCleanUp:
+    uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@r1
     needs:
-      - Params
-      - Release
-      - Package
+      - UnitTestingParams
+      - PublishCoverageResults
+      - PublishTestResults
+      - HTMLDocumentation
     with:
-      python_version: ${{ needs.Params.outputs.python_version }}
-      requirements: -r dist/requirements.txt
-      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
-    secrets:
-      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+      sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
+      xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
 
 #  VerifyDocs:
-#    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
+#    uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@r1
 #    needs:
-#      - Params
+#      - UnitTestingParams
 #    with:
-#      python_version: ${{ needs.Params.outputs.python_version }}
+#      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
 
-  BuildTheDocs:
-    uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@dev
+
+  HTMLDocumentation:
+    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r1
     needs:
-      - Params
-      #- VerifyDocs
+      - UnitTestingParams
+      - PublishTestResults
+      - PublishCoverageResults
+#      - VerifyDocs
     with:
-      artifact: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-ubuntu-native-3.12
+      coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
+      html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
+      latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
+
+#  PDFDocumentation:
+#    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@r1
+#    needs:
+#      - UnitTestingParams
+#      - HTMLDocumentation
+#    with:
+#      document: sphinx_reports
+#      latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
+#      pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
 
   PublishToGitHubPages:
-    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
+    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r1
     needs:
-      - Params
-      - BuildTheDocs
-      - Coverage
+      - UnitTestingParams
+      - HTMLDocumentation
+#      - PDFDocumentation
+      - PublishCoverageResults
       - StaticTypeCheck
     with:
-      doc: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
-      coverage: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
-      typing: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
+      doc: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
+#      coverage: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
+      typing: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
+
+  ReleasePage:
+    uses: pyTooling/Actions/.github/workflows/Release.yml@r1
+    if: startsWith(github.ref, 'refs/tags')
+    needs:
+      - Package
+      - PublishToGitHubPages
+
+  PublishOnPyPI:
+    uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@r1
+    if: startsWith(github.ref, 'refs/tags')
+    needs:
+      - UnitTestingParams
+      - ReleasePage
+    with:
+      python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
+      requirements: -r dist/requirements.txt
+      artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
+    secrets:
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
 
   ArtifactCleanUp:
-    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@dev
+    uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@r1
     needs:
-      - Params
+      - UnitTestingParams
       - UnitTesting
-      - Coverage
       - StaticTypeCheck
-      - BuildTheDocs
-      - PublishToGitHubPages
+      - HTMLDocumentation
+#      - PDFDocumentation
       - PublishTestResults
+      - PublishCoverageResults
+      - PublishToGitHubPages
+#      - PublishOnPyPI
     with:
-      package: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
+      package: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
       remaining: |
-        ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}-*
-        ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
-        ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
-        ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_html }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}-*
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_html }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
+        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
+#        ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,13 @@ __pycache__/
 .coverage
 .cov
 coverage.xml
+/report/coverage
+
+# mypy
+/report/typing
+
+# pytest
+/report/unit
 
 # setuptools
 /build/**/*.*
@@ -15,11 +22,16 @@ coverage.xml
 # Dependencies
 !requirements.txt
 
-# Sphinx documentation
-/doc/_build/
-/doc/_theme/
-/doc/pyEDAA.Reports/**/*.*
-!/doc/pyEDAA.Reports/index.rst
+# Sphinx
+doc/_build/
+doc/pyEDAA.Reports/**/*.*
+!doc/pyEDAA.Reports/index.rst
 
-# PyCharm project
+# BuildTheDocs
+doc/_theme/**/*.*
+
+# IntelliJ project files
 /.idea/workspace.xml
+
+# Git files
+!.git*