Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/reusable-build-and-deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,27 @@

<div align="center">

[![CI](https://github.com/matthewlee-dev/maya-python-project-template/actions/workflows/template-ci.yml/badge.svg)](https://github.com/matthewlee-dev/maya-python-project-template/actions/workflows/template-ci.yml)
[![Managed with uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![GitHub Actions][github-actions-shield]][github-actions-url]

<!-- PROJECT LOGO -->
<br />
<a href="https://github.com/matthewlee-dev/maya-python-project-template">
<img src="docs/resources/images/maya_python_logo.png" alt="MayaPythonLogo" width="175" height="175">
<img src="docs/resources/images/maya_python_logo.png" alt="MayaPythonLogo" width="250" height="250">
</a>

[![CI](https://github.com/matthewlee-dev/maya-python-project-template/actions/workflows/template-ci.yml/badge.svg)](https://github.com/matthewlee-dev/maya-python-project-template/actions/workflows/template-ci.yml)
[![Managed with uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](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]

<h3 align="center">Maya Python Project Template</h3>

<p align="center">
A GitHub template for Maya Python tools<br>
A GitHub template for Maya Python tools
<br />
<a href="https://matthewlee-dev.github.io/maya-python-project-template"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/matthewlee-dev/maya-python-project-template/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
·
<a href="https://github.com/matthewlee-dev/maya-python-project-template/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
Expand All @@ -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.
Expand Down