From 482a5a62dc9a57482fbab09e9aa9e82f7028dfe0 Mon Sep 17 00:00:00 2001
From: Tim Paine <3105306+timkpaine@users.noreply.github.com>
Date: Sun, 21 Jul 2024 18:34:31 -0400
Subject: [PATCH] add docs

---
 .github/workflows/docs.yml | 30 ++++++++++++++++++++++++++++++
 .gitignore                 |  1 +
 index.md                   | 28 ++++++++++++++++++++++++++++
 profile/README.md          |  3 ++-
 pyproject.toml             | 29 +++++++++++++++++++++++++++++
 5 files changed, 90 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/docs.yml
 create mode 100644 .gitignore
 create mode 100644 index.md
 create mode 100644 pyproject.toml

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..26679db
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,30 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+    paths-ignore:
+      - LICENSE
+      - README.md
+
+permissions:
+    contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+      - run: pip install yardang
+      - run: yardang build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/html
+          force_orphan: true
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a8ae8ed
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+docs/html
diff --git a/index.md b/index.md
new file mode 100644
index 0000000..66b02cd
--- /dev/null
+++ b/index.md
@@ -0,0 +1,28 @@
+```{toctree}
+---
+caption: ""
+maxdepth: 2
+hidden: true
+---
+
+
+
+```
+
+## Python Project Templates
+
+[![GitHub](https://img.shields.io/badge/repo-github-181717?logo=github&logoColor=white)](https://github.com/python-project-templates)
+[![License](https://img.shields.io/badge/license-Apache--2.0-brightgreen)](https://github.com/python-project-templates)
+
+This organization contains repos with examples of integrating Python with various tooling (CI/CD, linting, testing etc) and bindings/other language integration.
+
+| Type | Build | Description |
+|:-----|:-----|:------|
+| [Python](https://github.com/python-project-templates/python-template) | [![Build Status](https://github.com/python-project-templates/python-template/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template/actions/workflows/build.yml) | Pure Python |
+| [Python/C++](https://github.com/python-project-templates/cpp) | [![Build Status](https://github.com/python-project-templates/cpp/workflows/Build%20Status/badge.svg?branch=main)](https://github.com/python-project-templates/cpp/actions?query=workflow%3A%22Build+Status%22) | Python/C++ (binding via `pybind11` and/or standalone C++) |
+| [Python/Rust](https://github.com/python-project-templates/rust-template) | [![Build Status](https://github.com/python-project-templates/rust-template/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/rust-template/actions/workflows/build.yml) | Python with rust binding via `PyO3` |
+| [Python/Jupyter](https://github.com/python-project-templates/jupyter) | [![Build Status](https://github.com/python-project-templates/jupyter/workflows/Build%20Status/badge.svg?branch=main)](https://github.com/python-project-templates/jupyter/actions?query=workflow%3A%22Build+Status%22) | Python with Jupyter extension (JS) |
+| [Python/JavaScript](https://github.com/python-project-templates/js) | | Python with self-contained JS frontend |
+| [Python/JS/Rust](https://github.com/python-project-templates/rust-js-wasm) | [![Build Status](https://github.com/python-project-templates/rust-js-wasm/workflows/Build%20Status/badge.svg?branch=main)](https://github.com/python-project-templates/rust-js-wasm/actions?query=workflow%3A%22Build+Status%22) | Rust with Python binding (`PyO3`) and WebAssembly binding (to JS) |
+
+Don't see a template you want? Reach out via [discussions](https://github.com/python-project-templates/.github/discussions)
diff --git a/profile/README.md b/profile/README.md
index 9ad4d0f..ba89fb2 100644
--- a/profile/README.md
+++ b/profile/README.md
@@ -1,8 +1,9 @@
 ## Python Project Templates
 
+[![GitHub](https://img.shields.io/badge/repo-github-181717?logo=github&logoColor=white)](https://github.com/python-project-templates)
 [![License](https://img.shields.io/badge/license-Apache--2.0-brightgreen)](https://github.com/python-project-templates)
 
-This organization contains repos with examples of integrating Python with various tooling (CI/CD, linting, testing etc) and bindings/other language integration. 
+This organization contains repos with examples of integrating Python with various tooling (CI/CD, linting, testing etc) and bindings/other language integration.
 
 | Type | Build | Description |
 |:-----|:-----|:------|
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..e95a3a8
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,29 @@
+[build-system]
+requires = ["hatchling"]
+build-backend="hatchling.build"
+
+[project]
+name = "python-project-templates"
+authors = [{name = "the python-project-template authors", email = "t.paine154@gmail.com"}]
+description = "Python Project Templates"
+readme = "README.md"
+license = { text = "Apache-2.0" }
+version = "0.1.0"
+requires-python = ">=3.9"
+keywords = []
+classifiers = []
+dependencies = []
+
+[project.urls]
+Repository = "https://github.com/python-project-templates"
+Homepage = "https://python-templates.dev/"
+
+[project.optional-dependencies]
+develop = []
+
+[tool.yardang]
+title = "Python Project Templates"
+root = "profile/README.md"
+cname = "python-templates.dev"
+pages = []
+use-autoapi = false