Skip to content

Commit 482a5a6

Browse files
committed
add docs
1 parent 98d06e3 commit 482a5a6

5 files changed

Lines changed: 90 additions & 1 deletion

File tree

.github/workflows/docs.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
tags:
8+
- v*
9+
paths-ignore:
10+
- LICENSE
11+
- README.md
12+
13+
permissions:
14+
contents: write
15+
16+
jobs:
17+
docs:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-python@v4
22+
- run: pip install yardang
23+
- run: yardang build
24+
- name: Deploy
25+
uses: peaceiris/actions-gh-pages@v3
26+
with:
27+
publish_branch: gh-pages
28+
github_token: ${{ secrets.GITHUB_TOKEN }}
29+
publish_dir: docs/html
30+
force_orphan: true

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/html

index.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
```{toctree}
2+
---
3+
caption: ""
4+
maxdepth: 2
5+
hidden: true
6+
---
7+
8+
9+
10+
```
11+
12+
## Python Project Templates
13+
14+
[![GitHub](https://img.shields.io/badge/repo-github-181717?logo=github&logoColor=white)](https://github.com/python-project-templates)
15+
[![License](https://img.shields.io/badge/license-Apache--2.0-brightgreen)](https://github.com/python-project-templates)
16+
17+
This organization contains repos with examples of integrating Python with various tooling (CI/CD, linting, testing etc) and bindings/other language integration.
18+
19+
| Type | Build | Description |
20+
|:-----|:-----|:------|
21+
| [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 |
22+
| [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++) |
23+
| [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` |
24+
| [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) |
25+
| [Python/JavaScript](https://github.com/python-project-templates/js) | | Python with self-contained JS frontend |
26+
| [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) |
27+
28+
Don't see a template you want? Reach out via [discussions](https://github.com/python-project-templates/.github/discussions)

profile/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
## Python Project Templates
22

3+
[![GitHub](https://img.shields.io/badge/repo-github-181717?logo=github&logoColor=white)](https://github.com/python-project-templates)
34
[![License](https://img.shields.io/badge/license-Apache--2.0-brightgreen)](https://github.com/python-project-templates)
45

5-
This organization contains repos with examples of integrating Python with various tooling (CI/CD, linting, testing etc) and bindings/other language integration.
6+
This organization contains repos with examples of integrating Python with various tooling (CI/CD, linting, testing etc) and bindings/other language integration.
67

78
| Type | Build | Description |
89
|:-----|:-----|:------|

pyproject.toml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[build-system]
2+
requires = ["hatchling"]
3+
build-backend="hatchling.build"
4+
5+
[project]
6+
name = "python-project-templates"
7+
authors = [{name = "the python-project-template authors", email = "t.paine154@gmail.com"}]
8+
description = "Python Project Templates"
9+
readme = "README.md"
10+
license = { text = "Apache-2.0" }
11+
version = "0.1.0"
12+
requires-python = ">=3.9"
13+
keywords = []
14+
classifiers = []
15+
dependencies = []
16+
17+
[project.urls]
18+
Repository = "https://github.com/python-project-templates"
19+
Homepage = "https://python-templates.dev/"
20+
21+
[project.optional-dependencies]
22+
develop = []
23+
24+
[tool.yardang]
25+
title = "Python Project Templates"
26+
root = "profile/README.md"
27+
cname = "python-templates.dev"
28+
pages = []
29+
use-autoapi = false

0 commit comments

Comments
 (0)