compas-dev · chenkasirer · May 15, 2026 · May 15, 2026 · May 15, 2026 · May 15, 2026
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 .vscode
-.idea
+.idea
+.DS_Store
diff --git a/cookiecutter.json b/cookiecutter.json
@@ -7,8 +7,5 @@
     "author_name": "",
     "author_email": "",
     "github_username": "",
-    "github_organization": "",
-    "_extensions": [
-        "jinja2_time.TimeExtension"
-    ]
+    "github_organization": ""
 }
diff --git a/requirements.txt b/requirements.txt
diff --git a/tasks.py b/tasks.py
diff --git a/tests/test_trivial.py b/tests/test_trivial.py
diff --git a/{{cookiecutter.project_folder}}/.github/workflows/build.yml b/{{cookiecutter.project_folder}}/.github/workflows/build.yml
@@ -18,7 +18,7 @@ jobs:
         python: ["3.10", "3.11", "3.12"]
 
     steps:
-      - uses: compas-dev/compas-actions.build@v4
+      - uses: compas-dev/compas-actions.build@v5
         with:
           python: ${{ '{{' }} matrix.python {{ '}}' }}
           invoke_lint: true

diff --git a/{{cookiecutter.project_folder}}/.github/workflows/docs.yml b/{{cookiecutter.project_folder}}/.github/workflows/docs.yml
@@ -14,6 +14,8 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: compas-dev/compas-actions.docs@v4
+      - uses: compas-dev/compas-actions.docs@v5.0.1
         with:
           github_token: ${{ '{{' }} secrets.GITHUB_TOKEN {{ '}}' }}
+          generator: mkdocs
+          extras: dev
diff --git a/{{cookiecutter.project_folder}}/.github/workflows/pr-checks.yml b/{{cookiecutter.project_folder}}/.github/workflows/pr-checks.yml
@@ -11,9 +11,9 @@ jobs:
     name: Check Actions
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v6
       - name: Changelog check
-        uses: Zomzog/changelog-checker@v1.2.0
+        uses: Zomzog/changelog-checker@v1.3.0
         with:
           fileName: CHANGELOG.md
           checkNotification: Simple

diff --git a/{{cookiecutter.project_folder}}/.github/workflows/release.yml b/{{cookiecutter.project_folder}}/.github/workflows/release.yml
@@ -14,7 +14,7 @@ jobs:
         python: ['3.9', '3.10', '3.11']
 
     steps:
-      - uses: compas-dev/compas-actions.build@v4
+      - uses: compas-dev/compas-actions.build@v5
         with:
           python: ${{ '{{' }} matrix.python {{ '}}' }}
           invoke_lint: true
@@ -24,7 +24,7 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - uses: compas-dev/compas-actions.publish@v3
+      - uses: compas-dev/compas-actions.publish@v3.1.0
         with:
           pypi_token: ${{ '{{' }} secrets.PYPI {{ '}}' }}
           github_token: ${{ '{{' }} secrets.GITHUB_TOKEN {{ '}}' }}
diff --git a/{{cookiecutter.project_folder}}/docs/_images/PLACEHOLDER b/{{cookiecutter.project_folder}}/docs/_images/PLACEHOLDER
diff --git a/{{cookiecutter.project_folder}}/docs/_images/compas_logo_white_transparent.png b/{{cookiecutter.project_folder}}/docs/_images/compas_logo_white_transparent.png
diff --git a/{{cookiecutter.project_folder}}/docs/api.rst b/{{cookiecutter.project_folder}}/docs/api.rst
diff --git a/{{cookiecutter.project_folder}}/docs/api/{{cookiecutter.project_slug}}.md b/{{cookiecutter.project_folder}}/docs/api/{{cookiecutter.project_slug}}.md
@@ -0,0 +1 @@
+# ::: {{ cookiecutter.project_slug }}
diff --git a/{{cookiecutter.project_folder}}/docs/api/{{cookiecutter.project_slug}}.rst b/{{cookiecutter.project_folder}}/docs/api/{{cookiecutter.project_slug}}.rst
diff --git a/{{cookiecutter.project_folder}}/docs/assets/css/custom.css b/{{cookiecutter.project_folder}}/docs/assets/css/custom.css
@@ -0,0 +1,5 @@
+:root > * {
+  --md-primary-fg-color:        #0092d2;
+  --md-primary-fg-color--light: #0092d2;
+  --md-primary-fg-color--dark:  #0092d2;
+}
diff --git a/{{cookiecutter.project_folder}}/docs/conf.py b/{{cookiecutter.project_folder}}/docs/conf.py
diff --git a/{{cookiecutter.project_folder}}/docs/examples.md b/{{cookiecutter.project_folder}}/docs/examples.md
@@ -0,0 +1 @@
+# Examples
diff --git a/{{cookiecutter.project_folder}}/docs/examples.rst b/{{cookiecutter.project_folder}}/docs/examples.rst
diff --git a/{{cookiecutter.project_folder}}/docs/index.md b/{{cookiecutter.project_folder}}/docs/index.md
@@ -0,0 +1,17 @@
+# {{ cookiecutter.project_name }}
+
+{{ cookiecutter.project_short_description }}
+
+## Installation
+
+Stable releases can be installed from PyPI.
+
+```bash
+pip install {{ cookiecutter.project_slug }}
+```
+
+## First Steps
+
+```python
+import {{ cookiecutter.project_slug }}
+```
diff --git a/{{cookiecutter.project_folder}}/docs/index.rst b/{{cookiecutter.project_folder}}/docs/index.rst
diff --git a/{{cookiecutter.project_folder}}/docs/installation.md b/{{cookiecutter.project_folder}}/docs/installation.md
@@ -0,0 +1,29 @@
+# Installation
+
+## Stable
+
+Stable releases are available on PyPI and can be installed with pip.
+
+```bash
+pip install {{ cookiecutter.project_slug }}
+```
+
+## Latest
+
+The latest version can be installed from local source.
+
+```bash
+git clone https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}.git
+cd {{ cookiecutter.project_slug }}
+pip install -e .
+```
+
+## Development
+
+To install `{{ cookiecutter.project_slug }}` for development, install from local source with the "dev" requirements.
+
+```bash
+git clone https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}.git
+cd {{ cookiecutter.project_slug }}
+pip install -e .[dev]
+```