diff --git a/.github/workflows/reusable-build-and-deploy-docs.yml b/.github/workflows/reusable-build-and-deploy-docs.yml index ef89dc9..eb75de2 100644 --- a/.github/workflows/reusable-build-and-deploy-docs.yml +++ b/.github/workflows/reusable-build-and-deploy-docs.yml @@ -32,7 +32,7 @@ jobs: run: uv sync --only-group docs - name: Build the site - run: uv run --no-sync mkdocs build --strict + run: uv run --no-sync mkdocs build - name: Upload the site artifact uses: actions/upload-pages-artifact@v4 diff --git a/README.md b/README.md index 032ee6f..85a1290 100644 --- a/README.md +++ b/README.md @@ -2,24 +2,27 @@
+
-[](https://github.com/matthewlee-dev/maya-python-project-template/actions/workflows/template-ci.yml)
-[](https://github.com/astral-sh/uv)
-[](https://github.com/astral-sh/ruff)
[![Python][python_3-shield]][python-url]
[![Maya][maya-shield]][maya-url]
-[![GitHub Actions][github-actions-shield]][github-actions-url]
-
- A GitHub template for Maya Python tools
+ A GitHub template for Maya Python tools
+
+ Explore the docs »
+
+
Report Bug
·
Request Feature
@@ -31,6 +34,10 @@ Maya Python projects often start as a small collection of scripts and grow into
This template provides a modern, reproducible foundation for that infrastructure from the outset, so a tool can go from initial development to reliable distribution. The goal isn't to prescribe how a Maya tool should be written, just to remove the repetitive setup work around it.
+> [!NOTE]
+> Example project built from this template:
+> [locator-creator](https://github.com/matthewlee-dev/locator-creator).
+
## How to use this template
### Do not fork. Use the [Use this template][use-template-link] button instead.