init repo

Signed-off-by: msclock <[email protected]>

.copier-answers.yml

@@ -0,0 +1,12 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: 2023.11.17
+_src_path: gh:scientific-python/cookie
+backend: setuptools621
+email: [email protected]
+full_name: msclock
+license: Apache
+org: msclock
+project_name: sphinx-deployment
+project_short_description: A versioned documentation deployment tool for sphinx.
+url: https://github.com/msclock/sphinx-deployment
+vcs: true

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{yml,yaml,js}]
+indent_size = 2
+
+[*.{json,toml}]
+indent_size = 4

.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

.gitattributes

@@ -0,0 +1 @@
+.git_archival.txt  export-subst

.github/CONTRIBUTING.md

@@ -0,0 +1,101 @@
+See the [Scientific Python Developer Guide][spc-dev-intro] for a detailed
+description of best practices for developing scientific packages.
+
+[spc-dev-intro]: https://learn.scientific-python.org/development/
+
+# Quick development
+
+The fastest way to start with development is to use nox. If you don't have nox,
+you can use `pipx run nox` to run it without installing, or `pipx install nox`.
+If you don't have pipx (pip for applications), then you can install with
+`pip install pipx` (the only case were installing an application with regular
+pip is reasonable). If you use macOS, then pipx and nox are both in brew, use
+`brew install pipx nox`.
+
+To use, run `nox`. This will lint and test using every installed version of
+Python on your system, skipping ones that are not installed. You can also run
+specific jobs:
+
+```console
+$ nox -s lint  # Lint only
+$ nox -s tests  # Python tests
+$ nox -s docs -- serve  # Build and serve the docs
+$ nox -s build  # Make an SDist and wheel
+```
+
+Nox handles everything for you, including setting up an temporary virtual
+environment for each run.
+
+# Setting up a development environment manually
+
+You can set up a development environment by running:
+
+```bash
+python3 -m venv .venv
+source ./.venv/bin/activate
+pip install -v -e .[dev]
+```
+
+If you have the
+[Python Launcher for Unix](https://github.com/brettcannon/python-launcher), you
+can instead do:
+
+```bash
+py -m venv .venv
+py -m install -v -e .[dev]
+```
+
+# Post setup
+
+You should prepare pre-commit, which will help you by checking that commits pass
+required checks:
+
+```bash
+pip install pre-commit # or brew install pre-commit on macOS
+pre-commit install # Will install a pre-commit hook into the git repo
+```
+
+You can also/alternatively run `pre-commit run` (changes only) or
+`pre-commit run --all-files` to check even without installing the hook.
+
+# Testing
+
+Use pytest to run the unit checks:
+
+```bash
+pytest
+```
+
+# Coverage
+
+Use pytest-cov to generate coverage reports:
+
+```bash
+pytest --cov=sphinx-deployment
+```
+
+# Building docs
+
+You can build the docs using:
+
+```bash
+nox -s docs
+```
+
+You can see a preview with:
+
+```bash
+nox -s docs -- serve
+```
+
+# Pre-commit
+
+This project uses pre-commit for all style checking. While you can run it with
+nox, this is such an important tool that it deserves to be installed on its own.
+Install pre-commit and run:
+
+```bash
+pre-commit run -a
+```
+
+to check all files.

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/matchers/pylint.json

@@ -0,0 +1,32 @@
+{
+    "problemMatcher": [
+        {
+            "severity": "warning",
+            "pattern": [
+                {
+                    "regexp": "^([^:]+):(\\d+):(\\d+): ([A-DF-Z]\\d+): \\033\\[[\\d;]+m([^\\033]+).*$",
+                    "file": 1,
+                    "line": 2,
+                    "column": 3,
+                    "code": 4,
+                    "message": 5
+                }
+            ],
+            "owner": "pylint-warning"
+        },
+        {
+            "severity": "error",
+            "pattern": [
+                {
+                    "regexp": "^([^:]+):(\\d+):(\\d+): (E\\d+): \\033\\[[\\d;]+m([^\\033]+).*$",
+                    "file": 1,
+                    "line": 2,
+                    "column": 3,
+                    "code": 4,
+                    "message": 5
+                }
+            ],
+            "owner": "pylint-error"
+        }
+    ]
+}

.github/workflows/cd.yml

@@ -0,0 +1,117 @@
+name: CD
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+  release:
+    types:
+      - published
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: 3
+
+jobs:
+  dist:
+    name: Distribution build
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: hynek/build-and-inspect-python-package@v2
+
+  # publish-pypi:
+  #   needs: [dist]
+  #   name: Publish to PyPI
+  #   environment:
+  #     name: pypi
+  #     url: https://pypi.org/p/${{ github.event.repository.name }}
+  #   permissions:
+  #     id-token: write
+  #   runs-on: ubuntu-latest
+  #   if: github.event_name == 'release' && github.event.action == 'published'
+
+  #   steps:
+  #     - name: Download packages built by build-and-inspect-python-package
+  #       with:
+  #         name: Packages
+  #         path: dist
+  #       uses: actions/download-artifact@v4
+
+  #     - name: Upload package to PyPI
+  #       uses: pypa/gh-action-pypi-publish@release/v1
+  #       if:
+  #         github.event_name == 'release' && github.event.action == 'published'
+  #         && env.PYPI_API_TOKEN  != null
+  #       env:
+  #         PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN  }}
+  #       with:
+  #         password: ${{ secrets.PYPI_API_TOKEN }}
+
+  pages:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    if:
+      ${{ github.ref_name == github.event.repository.default_branch ||
+      (github.event_name == 'release' && github.event.action == 'published') }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ref: ${{ github.head_ref }}
+
+      - uses: wntrblm/[email protected]
+        with:
+          python-versions: "3.11"
+
+      - name: Verify no changes required to API docs
+        run: |
+          nox -s build_api_docs
+          git diff --exit-code
+
+      - name: Generate versioned docs
+        env:
+          VERSION_MODE: minor
+          VERSION_BRANCH: gh-pages
+        shell: bash
+        run: |
+          if [[ "${{ github.ref_name }}" == "${{ github.event.repository.default_branch }}" ]]; then
+            version_deploy="${{ github.ref_name }}"
+          else
+            _TAG=${{ github.ref_name }}
+            if [[ -n "$_TAG" ]]; then
+              case "$VERSION_MODE" in
+                "major")
+                  version_deploy=$(echo $_TAG | grep -oP "\K^v?\d+")
+                  ;;
+                "minor")
+                  version_deploy=$(echo $_TAG | grep -oP "\K^v?\d+\.\d+")
+                  ;;
+                "patch")
+                  version_deploy=$(echo $_TAG | grep -oP "\K^v?\d+\.\d+\.\d+")
+                  ;;
+                "none")
+                  version_deploy="latest"
+                  ;;
+                *)
+                  echo "VERSION_MODE only works on semver or 'none'" >> /dev/stderr
+                  exit 1
+              esac
+            fi
+          fi
+
+          nox -s versioned_docs -- create -b ${VERSION_BRANCH} -O . --push ${version_deploy}
+          if [[ "${{ github.event_name }}" == "release" && "${{ github.event.action }}" == "published" ]]; then
+            nox -s versioned_docs -- default -b ${VERSION_BRANCH} -O . --push ${version_deploy}
+          fi