docs(project-docs): set up mkdocs, github actions and doc rendering

ZeroTwentyFifty · Dec 15, 2024 · e2412c7 · e2412c7
1 parent ecadee6
commit e2412c7
Show file tree

Hide file tree

Showing 32 changed files with 477 additions and 855 deletions.
diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml
@@ -0,0 +1,57 @@
+name: Publish documentation
+
+on:
+  workflow_dispatch: # Allow manual triggers
+  push:
+    tags-ignore:
+      - '**' # Ignore any tags here
+    branches:
+      - master
+    #
+    # Trigger when either files in the docs folder,
+    # the requirements.txt file or the mkdocs.yml file
+    # are edited and commited.
+    paths:
+      - 'docs/**'
+      - 'requirements.txt'
+      - 'mkdocs.yml'
+
+# These permissions are required for it to work
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Makes sure only one workflow runs at a time.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  buildAndDeploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.pages_url }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Setup Python 3.x
+        uses: actions/setup-python@v4
+        with:
+          python_version: '3.x' # Uses latest 3.x version.
+      - name: Install dependencies
+        # Alternatively: pip install mkdocs
+        run: pip install mkdocs mkdocs-material
+      - name: Build Docs
+        run: mkdocs build
+      - name: Configure GitHub Pages
+        # I have no idea if this actually needed...
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: 'site/' # MkDocs builds to site/ by default
+      - name: Deploy to GitHub Pages
+        id: deployment # This is required for environment
+        uses: actions/deploy-pages@v2
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/README.md → docs/README.md b/README.md → docs/README.md
diff --git a/docs/developer_contribution_guide.md b/docs/developer_contribution_guide.md
@@ -0,0 +1,8 @@
+# Developer Contribution Guide
+
+Use commitizen for commit messages:
+https://commitizen.github.io/cz-cli/
+
+Use Conventional Commits for commit messages:
+https://www.conventionalcommits.org/en/v1.0.0/
+
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/...mmary/pathfinder_framework.carbon_footprint.biogenic_accounting_methodology.rst b/...mmary/pathfinder_framework.carbon_footprint.biogenic_accounting_methodology.rst
diff --git a/..._autosummary/pathfinder_framework.carbon_footprint.characterization_factors.rst b/..._autosummary/pathfinder_framework.carbon_footprint.characterization_factors.rst
diff --git a/.../_autosummary/pathfinder_framework.carbon_footprint.cross_sectoral_standard.rst b/.../_autosummary/pathfinder_framework.carbon_footprint.cross_sectoral_standard.rst
diff --git a/docs/source/_autosummary/pathfinder_framework.carbon_footprint.declared_unit.rst b/docs/source/_autosummary/pathfinder_framework.carbon_footprint.declared_unit.rst
diff --git a/...ource/_autosummary/pathfinder_framework.carbon_footprint.geographical_scope.rst b/...ource/_autosummary/pathfinder_framework.carbon_footprint.geographical_scope.rst
diff --git a/...hfinder_framework.carbon_footprint.product_or_sector_specific_rule_operator.rst b/...hfinder_framework.carbon_footprint.product_or_sector_specific_rule_operator.rst
diff --git a/...urce/_autosummary/pathfinder_framework.carbon_footprint.region_or_subregion.rst b/...urce/_autosummary/pathfinder_framework.carbon_footprint.region_or_subregion.rst