From 1886b31bdce9b70fcff3d6b7ddee182b1a063f6d Mon Sep 17 00:00:00 2001 From: Tim Paine <3105306+timkpaine@users.noreply.github.com> Date: Sat, 2 Aug 2025 16:51:12 -0400 Subject: [PATCH] reinit copier --- .copier-answers.yaml | 2 +- .github/workflows/docs.yaml | 22 ++++++++++++++++++++++ .github/workflows/wiki.yaml | 2 +- .gitignore | 3 +++ Makefile | 5 +++++ pyproject.toml | 9 ++++++++- 6 files changed, 40 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/docs.yaml diff --git a/.copier-answers.yaml b/.copier-answers.yaml index 2bcc6d4..54ca710 100644 --- a/.copier-answers.yaml +++ b/.copier-answers.yaml @@ -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 diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 0000000..935507a --- /dev/null +++ b/.github/workflows/docs.yaml @@ -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 diff --git a/.github/workflows/wiki.yaml b/.github/workflows/wiki.yaml index 1588acd..d5f3b74 100644 --- a/.github/workflows/wiki.yaml +++ b/.github/workflows/wiki.yaml @@ -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 diff --git a/.gitignore b/.gitignore index 6cc6dca..396acf9 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/Makefile b/Makefile index 13ba044..c713692 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 99f6a48..826019c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"] \ No newline at end of file +"__init__.py" = ["F401", "F403"] + +[tool.yardang] +title = "python template" +root = "README.md" +pages = [] +use-autoapi = true +