ci: update jobs and noxfile (#929)

* ci: update jobs and noxfile Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> * chore: fix config for pylint 3 Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> * style: pre-commit fixes --------- Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
scikit-hep · May 10, 2024 · 0964629 · 0964629
1 parent e7d02ca
commit 0964629
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 40 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -2,7 +2,7 @@
 # Skip dependabot and pre-commit-ci PRs
 needs changelog:
   - all:
-    - changed-files:
-        - all-globs-to-all-files: "!docs/CHANGELOG.md"
-    - base-branch: "^(?!dependabot).*"
-    - base-branch: "^(?!pre-commit-ci).*"
+      - changed-files:
+          - all-globs-to-all-files: "!docs/CHANGELOG.md"
+      - base-branch: "^(?!dependabot).*"
+      - base-branch: "^(?!pre-commit-ci).*"
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -52,7 +52,7 @@ jobs:
       - name: Run PyLint
         run: |
           echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json"
-          pipx run nox -s pylint
+          pipx run nox[uv] -s pylint
 
   cmake:
     name: CMake 🐍 ${{ matrix.python-version }}
@@ -115,10 +115,6 @@ jobs:
           submodules: true
           fetch-depth: 0
 
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.x"
-
       - uses: pypa/cibuildwheel@v2.17
         env:
           CIBW_BUILD: "${{ matrix.build }}"
@@ -129,12 +125,8 @@ jobs:
           path: wheelhouse/*
           name: test-wheels-${{ strategy.job-index }}
 
-      # Pipx is either missing or broken on macos-14 runners ATM
-      - name: Install twine
-        run: pip install twine
-
       - name: Check wheels
-        run: twine check wheelhouse/*
+        run: pipx run twine check wheelhouse/*
         shell: bash
 
   pass:

diff --git a/noxfile.py b/noxfile.py
@@ -48,41 +48,31 @@ def hist(session: nox.Session) -> None:
 @nox.session(reuse_venv=True)
 def docs(session: nox.Session) -> None:
     """
-    Build the docs. Pass "--serve" to serve. Pass "-b linkcheck" to check links.
+    Build the docs. Pass --non-interactive to avoid serving. Pass "-b linkcheck" to check links.
     """
 
     parser = argparse.ArgumentParser()
-    parser.add_argument("--serve", action="store_true", help="Serve after building")
     parser.add_argument(
         "-b", dest="builder", default="html", help="Build target (default: html)"
     )
     args, posargs = parser.parse_known_args(session.posargs)
+    serve = args.builder == "html" and session.interactive
 
-    if args.builder != "html" and args.serve:
-        session.error("Must not specify non-HTML builder with --serve")
-
-    extra_installs = ["sphinx-autobuild"] if args.serve else []
-
-    session.chdir("docs")
-    session.install("-r", "requirements.txt", *extra_installs)
-
-    if args.builder == "linkcheck":
-        session.run(
-            "sphinx-build", "-b", "linkcheck", ".", "_build/linkcheck", *posargs
-        )
-        return
+    extra_installs = ["sphinx-autobuild"] if serve else []
+    session.install("-r", "docs/requirements.txt", *extra_installs)
 
     shared_args = (
         "-n",  # nitpicky mode
         "-T",  # full tracebacks
         f"-b={args.builder}",
-        ".",
-        f"_build/{args.builder}",
-        *posargs,
+        "docs",
+        *(posargs or [f"docs/_build/{args.builder}"]),
     )
 
-    if args.serve:
-        session.run("sphinx-autobuild", *shared_args)
+    if serve:
+        session.run(
+            "sphinx-autobuild", "--open-browser", "--ignore=docs/.build", *shared_args
+        )
     else:
         session.run("sphinx-build", "--keep-going", *shared_args)
 
@@ -94,22 +84,21 @@ def build_api_docs(session: nox.Session) -> None:
     """
 
     session.install(".", "-r", "docs/requirements.txt")
-    session.chdir("docs")
     session.run(
         "sphinx-apidoc",
         "-o",
-        "api/",
+        "docs/api/",
         "--no-toc",
         "--template",
-        "template/",
+        "docs/template/",
         "--force",
         "--module-first",
-        "../src/boost_histogram",
+        "src/boost_histogram",
     )
 
     # add API docs of boost_histogram._internal.hist.Histogram after
     # the generation step
-    with Path("api/boost_histogram.rst").open("r+") as f:
+    with Path("docs/api/boost_histogram.rst").open("r+") as f:
         lines = f.readlines()
         for i in range(len(lines)):
             if lines[i] == ".. automodule:: boost_histogram\n":
@@ -137,7 +126,7 @@ def pylint(session: nox.Session) -> None:
     Run pylint.
     """
 
-    session.install("pylint==2.17.*")
+    session.install("pylint==3.1.*")
     session.install(".")
     session.run("pylint", "src", *session.posargs)
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -169,6 +169,7 @@ environment.PIP_PREFER_BINARY = "1"
 
 [tool.pylint]
 py-version = "3.7"
+ignore-patterns = ['.*\.pyi']
 extension-pkg-allow-list = ["boost_histogram._core"]
 reports.output-format = "colorized"
 similarities.ignore-imports = "yes"