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 .copier-answers.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Changes here will be overwritten by Copier
_commit: a03224b
_commit: 3eae34f
_src_path: https://github.com/python-project-templates/base.git
add_docs: true
add_extension: python
Expand Down
22 changes: 22 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Docs
on:
push:
branches:
- main
workflow_dispatch:
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions-ext/python/setup@main
- run: uv pip install .
- run: uv pip install yardang
- run: yardang build
- uses: peaceiris/actions-gh-pages@v4
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/html
2 changes: 1 addition & 1 deletion .github/workflows/wiki.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ jobs:
steps:
- uses: actions/checkout@v4
- run: cp README.md docs/wiki/Home.md
- uses: Andrew-Chen-Wang/github-wiki-action@v4
- uses: Andrew-Chen-Wang/github-wiki-action@v5
with:
path: docs/wiki
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,13 @@ js/dist
js/lib
js/node_modules
js/*.tgz
python_template/extension

# Jupyter
.ipynb_checkpoints
.autoversion
!python_template/extension/python_template.json
!python_template/extension/install.json
python_template/nbextension
python_template/labextension

Expand Down
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
develop: ## install dependencies and build library
uv pip install -e .[develop]

requirements: ## install prerequisite python build requirements
python -m pip install --upgrade pip toml
python -m pip install `python -c 'import toml; c = toml.load("pyproject.toml"); print("\n".join(c["build-system"]["requires"]))'`
python -m pip install `python -c 'import toml; c = toml.load("pyproject.toml"); print(" ".join(c["project"]["optional-dependencies"]["develop"]))'`

build: ## build the python library
python -m build -n

Expand Down
9 changes: 8 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -118,4 +118,11 @@ known-first-party = ["python_template"]
section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401", "F403"]
"__init__.py" = ["F401", "F403"]

[tool.yardang]
title = "python template"
root = "README.md"
pages = []
use-autoapi = true

Loading