Skip to content

Commit 824d7d9

Browse files
authored
Merge pull request #1 from python-project-templates/tkp/link-actions-profile
Keep Pages site in sync with organization profile
2 parents e6e430a + 6270915 commit 824d7d9

4 files changed

Lines changed: 41 additions & 71 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,45 @@ on:
44
push:
55
branches:
66
- main
7-
tags:
8-
- v*
9-
paths-ignore:
10-
- LICENSE
11-
- README.md
7+
paths:
8+
- .github/workflows/docs.yml
9+
- index.md
10+
- profile/README.md
11+
- pyproject.toml
1212
workflow_dispatch:
1313

14+
concurrency:
15+
group: docs
16+
cancel-in-progress: false
17+
1418
permissions:
15-
contents: write
19+
contents: write
1620

1721
jobs:
1822
docs:
1923
runs-on: ubuntu-latest
24+
2025
steps:
21-
- uses: actions/checkout@v4
22-
- uses: actions/setup-python@v5
26+
- name: Checkout
27+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
2328
with:
24-
python-version: '3.11'
25-
- run: pip install yardang
26-
- run: yardang build
27-
- name: Deploy
28-
uses: peaceiris/actions-gh-pages@v4
29+
persist-credentials: false
30+
31+
- name: Setup Python
32+
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
2933
with:
30-
publish_branch: gh-pages
34+
python-version: "3.11"
35+
36+
- name: Install Yardang
37+
run: pip install yardang
38+
39+
- name: Build Pages
40+
run: yardang build
41+
42+
- name: Deploy Pages
43+
uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
44+
with:
45+
force_orphan: true
3146
github_token: ${{ secrets.GITHUB_TOKEN }}
47+
publish_branch: gh-pages
3248
publish_dir: docs/html
33-
force_orphan: true

‎index.md‎

Lines changed: 1 addition & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,2 @@
1-
```{toctree}
2-
---
3-
caption: ""
4-
maxdepth: 2
5-
hidden: true
6-
---
1+
```{include} profile/README.md
72
```
8-
9-
## Python Project Templates
10-
11-
This organization contains repos with examples of integrating Python with various tooling (CI/CD, linting, testing etc) and bindings/other language integration.
12-
13-
```bash
14-
pip install copier
15-
copier copy https://github.com/python-project-templates/base.git path/to/new/project
16-
```
17-
18-
### Python Templates
19-
20-
[![Base Template](https://img.shields.io/badge/template-base-blue)](https://github.com/python-project-templates/base)
21-
[![GitHub](https://img.shields.io/badge/repo-github-181717?logo=github&logoColor=white)](https://github.com/python-project-templates)
22-
[![Copier](https://img.shields.io/badge/copier-docs-f8c200.svg?logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iNzgiIGZpbGw9Im5vbmUiPjxwYXRoIGZpbGw9IiNEREQiIHN0cm9rZT0iI0RERCIgc3Ryb2tlLXdpZHRoPSI2IiBkPSJtNzUuMjQgOC41OTMgMTcuODE4IDEzLjg0NWE5LjIgOS4yIDAgMCAxIDEuNjIyIDEyLjkzOEw2Ny4yMjQgNzAuNzA5YTkuMiA5LjIgMCAwIDEtMTIuOTM4IDEuNjIzTDM2LjQ2OSA1OC40ODZhOS4yIDkuMiAwIDAgMS0xLjYyMy0xMi45MzhsMjcuNDU3LTM1LjMzM0E5LjIgOS4yIDAgMCAxIDc1LjI0IDguNTkzWm0tMTkuODg0LTQuNTIgMjAuNTMgOS4zNjJhOS4yIDkuMiAwIDAgMSA0LjU2NCAxMi4yMTRMNjEuODg1IDY2LjM2M2E5LjIgOS4yIDAgMCAxLTEyLjIxNSA0LjU2NGwtMjAuNTMtOS4zNjJhOS4yIDkuMiAwIDAgMS00LjU2NC0xMi4yMTVMNDMuMTQyIDguNjM3YTkuMiA5LjIgMCAwIDEgMTIuMjE0LTQuNTY0Wm0tMTUuOTMtLjk0MSAyMi4yNSAzLjc2MWE5LjA3NCA5LjA3NCAwIDAgMSA3LjQ1IDEwLjYxbC03Ljk2MyA0NC4wMzNhOS4zMjcgOS4zMjcgMCAwIDEtMTAuNzMxIDcuNTM2bC0yMi4yNDktMy43NjFhOS4wNzQgOS4wNzQgMCAwIDEtNy40NS0xMC42MWw3Ljk2Mi00NC4wMzNhOS4zMjcgOS4zMjcgMCAwIDEgMTAuNzMyLTcuNTM2Wk0yNS4zODYgNS44NjRsMjIuNTQ2LS45YTkuMiA5LjIgMCAwIDEgOS41OCA4Ljg0NWwxLjc4NiA0NC43MTFhOS4yIDkuMiAwIDAgMS04Ljg0NSA5LjU4bC0yMi41NDcuOWE5LjIgOS4yIDAgMCAxLTkuNTgtOC44NDRMMTYuNTQgMTUuNDQ0YTkuMiA5LjIgMCAwIDEgOC44NDUtOS41OFpNOS40MjkgMTEuOTJsMjEuNTAyLTYuODQzYTkuMiA5LjIgMCAwIDEgMTEuNTgyIDUuOTlsMTMuNTcxIDQyLjYzOGE5LjIgOS4yIDAgMCAxLTUuOTkgMTEuNTgzbC0yMS41IDYuODQzYTkuMiA5LjIgMCAwIDEtMTEuNTgzLTUuOTlMMy40NCAyMy41MDRhOS4yIDkuMiAwIDAgMSA1Ljk5LTExLjU4MloiLz48cGF0aCBmaWxsPSIjMTExODI3IiBzdHJva2U9IiMwMDAiIHN0cm9rZS13aWR0aD0iMi40MjIiIGQ9Im05LjQzIDExLjkyMSAyMS41LTYuODQzYTkuMiA5LjIgMCAwIDEgMTEuNTgzIDUuOTlsMTMuNTcxIDQyLjYzOGE5LjIgOS4yIDAgMCAxLTUuOTkgMTEuNTgzbC0yMS41IDYuODQzYTkuMiA5LjIgMCAwIDEtMTEuNTgzLTUuOTlMMy40NCAyMy41MDRhOS4yIDkuMiAwIDAgMSA1Ljk5LTExLjU4MloiLz48cGF0aCBmaWxsPSIjMzc0MTUxIiBzdHJva2U9IiMwMDAiIHN0cm9rZS13aWR0aD0iMi40MjIiIGQ9Im0yNS4zODUgNS44NjQgMjIuNTQ2LS45YTkuMiA5LjIgMCAwIDEgOS41OCA4Ljg0NWwxLjc4NiA0NC43MTFhOS4yIDkuMiAwIDAgMS04Ljg0NSA5LjU4bC0yMi41NDcuOWE5LjIgOS4yIDAgMCAxLTkuNTgtOC44NDRMMTYuNTQgMTUuNDQ0YTkuMiA5LjIgMCAwIDEgOC44NDUtOS41OFoiLz48cGF0aCBmaWxsPSIjNkI3MjgwIiBzdHJva2U9IiMwMDAiIHN0cm9rZS13aWR0aD0iMi40MjIiIGQ9Im0zOS40MjYgMy4xMzIgMjIuMjQ5IDMuNzYxYTkuMDc0IDkuMDc0IDAgMCAxIDcuNDUgMTAuNjFsLTcuOTYyIDQ0LjAzM2E5LjMyNyA5LjMyNyAwIDAgMS0xMC43MzEgNy41MzZsLTIyLjI0OS0zLjc2MWE5LjA3NCA5LjA3NCAwIDAgMS03LjQ1LTEwLjYxbDcuOTYyLTQ0LjAzM2E5LjMyNyA5LjMyNyAwIDAgMSAxMC43MzEtNy41MzZaIi8+PHBhdGggZmlsbD0iI0QxRDVEQiIgc3Ryb2tlPSIjMDAwIiBzdHJva2Utd2lkdGg9IjIuNDIyIiBkPSJtNTUuMzU2IDQuMDczIDIwLjUzIDkuMzYyYTkuMiA5LjIgMCAwIDEgNC41NjQgMTIuMjE0TDYxLjg4NSA2Ni4zNjNhOS4yIDkuMiAwIDAgMS0xMi4yMTUgNC41NjRsLTIwLjUzLTkuMzYyYTkuMiA5LjIgMCAwIDEtNC41NjQtMTIuMjE1TDQzLjE0MiA4LjYzN2E5LjIgOS4yIDAgMCAxIDEyLjIxNC00LjU2NFoiLz48cGF0aCBmaWxsPSIjRjNGNEY2IiBzdHJva2U9IiMwMDAiIHN0cm9rZS13aWR0aD0iMi40MjIiIGQ9Im03NS4yNCA4LjU5MyAxNy44MTggMTMuODQ1YTkuMiA5LjIgMCAwIDEgMS42MjIgMTIuOTM4TDY3LjIyNCA3MC43MDlhOS4yIDkuMiAwIDAgMS0xMi45MzggMS42MjNMMzYuNDY5IDU4LjQ4NmE5LjIgOS4yIDAgMCAxLTEuNjIzLTEyLjkzOGwyNy40NTctMzUuMzMzQTkuMiA5LjIgMCAwIDEgNzUuMjQgOC41OTNaIi8+PC9zdmc+)](https://copier.readthedocs.io/en/stable/)
23-
[![License](https://img.shields.io/badge/license-Apache--2.0-brightgreen)](https://github.com/python-project-templates/base)
24-
25-
| Type | Build | Description |
26-
| :------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------- |
27-
| [Python](https://github.com/python-project-templates/python-template) | [![Build Status](https://github.com/python-project-templates/python-template/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template/actions/workflows/build.yaml) | Pure Python |
28-
| [Python/C++](https://github.com/python-project-templates/python-template-cpp) | [![Build Status](https://github.com/python-project-templates/python-template-cpp/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template-cpp/actions/workflows/build.yaml) | Python/C++ (binding via `pybind11` and/or standalone C++) |
29-
| [Python/Rust](https://github.com/python-project-templates/python-template-rust) | [![Build Status](https://github.com/python-project-templates/python-template-rust/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template-rust/actions/workflows/build.yaml) | Python with rust binding via `PyO3` |
30-
| [Python/Jupyter](https://github.com/python-project-templates/python-template-jupyter) | [![Build Status](https://github.com/python-project-templates/python-template-jupyter/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template-jupyter/actions/workflows/build.yaml) | Python with Jupyter extension (JS) |
31-
| [Python/JavaScript](https://github.com/python-project-templates/python-template-js) | [![Build Status](https://github.com/python-project-templates/python-template-js/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template-js/actions/workflows/build.yaml) | Python with self-contained JS frontend |
32-
| [Python/JS/Rust](https://github.com/python-project-templates/rust-js-wasm-template) | [![Build Status](https://github.com/python-project-templates/rust-js-wasm-template/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/rust-js-wasm-template) | Rust with Python binding (`PyO3`) and WebAssembly binding (to JS) |
33-
| [Python/Zig](https://github.com/python-project-templates/python-template-zig) | [![Build Status](https://github.com/python-project-templates/python-template-zig/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template-zig/actions?query=workflow%3A%22Build+Status%22) | Python with zig binding via `ziggy-pydust` |
34-
35-
### Other Templates
36-
37-
| Type | Build | Description |
38-
| :---------- | :---- | :---------- |
39-
| Coming soon | | |
40-
41-
### Other Tools
42-
43-
| Name | Version | Description |
44-
| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------- |
45-
| [yardang](https://yardang.python-templates.dev) | [![PyPI](https://img.shields.io/pypi/v/yardang.svg)](https://pypi.python.org/pypi/yardang) | yardang is a Python library for generating Sphinx documentation |
46-
| [hatch-cpp](https://github.com/python-project-templates/hatch-cpp) | [![PyPI](https://img.shields.io/pypi/v/hatch-cpp.svg)](https://pypi.python.org/pypi/hatch-cpp) | `hatch-cpp` is a [hatch](https://hatch.pypa.io/latest/) plugin for C++ |
47-
| [hatch-js](https://github.com/python-project-templates/hatch-js) | [![PyPI](https://img.shields.io/pypi/v/hatch-js.svg)](https://pypi.python.org/pypi/hatch-js) | `hatch-js` is a [hatch](https://hatch.pypa.io/latest/) plugin for JavaScript |
48-
| [hatch-multi](https://github.com/python-project-templates/hatch-multi) | [![PyPI](https://img.shields.io/pypi/v/hatch-multi.svg)](https://pypi.python.org/pypi/hatch-multi) | `hatch-multi` is a [hatch](https://hatch.pypa.io/latest/) plugin to create multiple discrete <br/> packages from optional-dependencies (extras) |
49-
50-
Don't see a template you want? Reach out via [discussions](https://github.com/python-project-templates/base/discussions)

‎profile/README.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
## Python Project Templates
1+
# Python Project Templates
22

33
This organization contains repos with examples of integrating Python with various tooling (CI/CD, linting, testing etc) and bindings/other language integration.
44

5+
Reusable GitHub Actions and Apps supporting these projects are maintained by [Extension Actions](https://actions.python-templates.dev/) ([GitHub](https://github.com/actions-ext)).
6+
57
```bash
68
pip install copier
79
copier copy https://github.com/python-project-templates/base.git path/to/new/project
810
```
911

10-
### Python Templates
12+
## Python Templates
1113

1214
[![Base Template](https://img.shields.io/badge/template-base-blue)](https://github.com/python-project-templates/base)
1315
[![GitHub](https://img.shields.io/badge/repo-github-181717?logo=github&logoColor=white)](https://github.com/python-project-templates)
@@ -24,25 +26,25 @@ copier copy https://github.com/python-project-templates/base.git path/to/new/pro
2426
| [Python/JS/Rust](https://github.com/python-project-templates/python-template-rustjswasm) | [![Build Status](https://github.com/python-project-templates/python-template-rustjswasm/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template-rustjswasm) | Rust with Python binding (`PyO3`) and WebAssembly binding (to JS) |
2527
| [Python/JS/C++](https://github.com/python-project-templates/python-template-cppjswasm) | [![Build Status](https://github.com/python-project-templates/python-template-cppjswasm/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template-cppjswasm) | C++ with Python binding (`pybind11`) and WebAssembly binding (to JS) |
2628

27-
### Other Templates
29+
## Other Templates
2830

2931
| Type | Build | Description |
3032
| :---------- | :---- | :---------- |
3133
| [Python/Go](https://github.com/python-project-templates/python-template-go) | [![Build Status](https://github.com/python-project-templates/python-template-go/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template-go/actions?query=workflow%3A%22Build+Status%22) | Python with Go binding via C API |
3234
| [Python/Zig](https://github.com/python-project-templates/python-template-zig) | [![Build Status](https://github.com/python-project-templates/python-template-zig/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/python-project-templates/python-template-zig/actions?query=workflow%3A%22Build+Status%22) | Python with Zig binding via `ziggy-pydust` |
3335
| Coming soon | | |
3436

35-
### Other Tools
37+
## Other Tools
3638

3739
| Name | Version | Description |
3840
| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- |
3941
| [yardang](https://yardang.python-templates.dev) | [![PyPI](https://img.shields.io/pypi/v/yardang.svg)](https://pypi.python.org/pypi/yardang) | yardang is a Python library for generating Sphinx documentation |
40-
| [check-dist](https://github.com/python-project-templates/check-dist) | [![PyPI](https://img.shields.io/pypi/v/yardang.svg)](https://pypi.python.org/pypi/check-dist) | check-dist is a Python library for sanity-checking source and wheel distribution included files |
42+
| [check-dist](https://github.com/python-project-templates/check-dist) | [![PyPI](https://img.shields.io/pypi/v/check-dist.svg)](https://pypi.python.org/pypi/check-dist) | check-dist is a Python library for sanity-checking source and wheel distribution included files |
4143
| [hatch-build](https://github.com/python-project-templates/hatch-build) | [![PyPI](https://img.shields.io/pypi/v/hatch-build.svg)](https://pypi.python.org/pypi/hatch-build) | A minimal CLI wrapper around [hatchling build](https://hatch.pypa.io/latest/) |
4244
| [hatch-cpp](https://github.com/python-project-templates/hatch-cpp) | [![PyPI](https://img.shields.io/pypi/v/hatch-cpp.svg)](https://pypi.python.org/pypi/hatch-cpp) | `hatch-cpp` is a [hatch](https://hatch.pypa.io/latest/) plugin for C++ |
4345
| [hatch-js](https://github.com/python-project-templates/hatch-js) | [![PyPI](https://img.shields.io/pypi/v/hatch-js.svg)](https://pypi.python.org/pypi/hatch-js) | `hatch-js` is a [hatch](https://hatch.pypa.io/latest/) plugin for JavaScript |
4446
| [hatch-rs](https://github.com/python-project-templates/hatch-rs) | [![PyPI](https://img.shields.io/pypi/v/hatch-rs.svg)](https://pypi.python.org/pypi/hatch-rs) | `hatch-rs` is a [hatch](https://hatch.pypa.io/latest/) plugin for Rust |
45-
| [hatch-go](https://github.com/python-project-templates/hatch-go) | [![PyPI](https://img.shields.io/pypi/v/hatch-zig.svg)](https://pypi.python.org/pypi/hatch-go) | `hatch-go` is a [hatch](https://hatch.pypa.io/latest/) plugin for Go |
47+
| [hatch-go](https://github.com/python-project-templates/hatch-go) | [![PyPI](https://img.shields.io/pypi/v/hatch-go.svg)](https://pypi.python.org/pypi/hatch-go) | `hatch-go` is a [hatch](https://hatch.pypa.io/latest/) plugin for Go |
4648
| [hatch-zig](https://github.com/python-project-templates/hatch-zig) | [![PyPI](https://img.shields.io/pypi/v/hatch-zig.svg)](https://pypi.python.org/pypi/hatch-zig) | `hatch-zig` is a [hatch](https://hatch.pypa.io/latest/) plugin for Zig |
4749
| [hatch-multi](https://github.com/python-project-templates/hatch-multi) | [![PyPI](https://img.shields.io/pypi/v/hatch-multi.svg)](https://pypi.python.org/pypi/hatch-multi) | `hatch-multi` is a [hatch](https://hatch.pypa.io/latest/) plugin to create multiple discrete <br/> packages from optional-dependencies (extras) |
4850

‎pyproject.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ develop = []
2323

2424
[tool.yardang]
2525
title = "Python Project Templates"
26-
root = "profile/README.md"
26+
root = "index.md"
2727
cname = "python-templates.dev"
28+
exclude-patterns = ["profile/README.md"]
2829
pages = []
2930
use-autoapi = false

0 commit comments

Comments
 (0)