-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
90 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| docs/html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| ```{toctree} | ||
| --- | ||
| caption: "" | ||
| maxdepth: 2 | ||
| hidden: true | ||
| --- | ||
| ``` | ||
|
|
||
| ## Python Project Templates | ||
|
|
||
| [](https://github.com/python-project-templates) | ||
| [](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) | [](https://github.com/python-project-templates/python-template/actions/workflows/build.yml) | Pure Python | | ||
| | [Python/C++](https://github.com/python-project-templates/cpp) | [](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) | [](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) | [](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) | [](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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 = "[email protected]"}] | ||
| 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 |