This commit adds MkDocs to the project for documentation generation.

- Adds mkdocs and mkdocs-material as development dependencies.
- Creates a mkdocs.yml configuration file.
- Creates an initial docs/index.md file.
- Updates .gitignore to exclude the site/ directory.
- Adds a build-docs job to the CI/CD pipeline to build the documentation.

Author: google-labs-jules[bot]

.github/workflows/ci-cd.yml

@@ -75,9 +75,42 @@ jobs:
           fail_ci_if_error: true
           verbose: true
 
+  build-docs:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
+      - name: Set up Python
+        uses: actions/setup-python@cfd55ca82492758d853442341ad4d8010466803a
+        with:
+          python-version: '3.12'
+
+      - name: Install Poetry
+        uses: snok/install-poetry@ff8a7d7de27005376176819789742a2280cc35e2
+
+      - name: Configure Poetry
+        run: poetry config virtualenvs.in-project true
+        shell: bash
+
+      - name: Cache dependencies
+        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830
+        with:
+          path: .venv
+          key: v1-${{ runner.os }}-python-3.12-${{ hashFiles('**/poetry.lock') }}
+          restore-keys: |
+            v1-${{ runner.os }}-python-3.12-
+
+      - name: Install dependencies
+        run: poetry install --no-interaction --no-root
+        shell: bash
+
+      - name: Build documentation
+        run: poetry run mkdocs build --strict
+        shell: bash
+
   release:
     if: startsWith(github.ref, 'refs/tags/v')
-    needs: test
+    needs: build-docs
     runs-on: ubuntu-latest
     permissions:
       id-token: write

.gitignore

@@ -128,7 +128,7 @@ venv.bak/
 .ropeproject
 
 # mkdocs documentation
-/site
+site/
 
 # mypy
 .mypy_cache/

docs/index.md

@@ -0,0 +1,3 @@
+# Welcome to my_python_project!
+
+This is the main page of your project's documentation.

mkdocs.yml

@@ -0,0 +1,3 @@
+site_name: my_python_project
+theme:
+  name: material