build: use nox for github actions (#30)

Author: 12rambau

.github/workflows/unit.yaml

@@ -14,38 +14,65 @@ jobs:
           python-version: "3.10"
       - uses: pre-commit/[email protected]
 
-  build:
+  mypy:
     runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install nox
+        run: pip install nox
+      - name: Check static typing
+        run: nox -s mypy
+
+  build:
+    needs: [lint, mypy]
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        os: [ubuntu-latest]
+        python-version: ["3.9", "3.10", "3.11"]
         include:
           - os: macos-latest
-            python-version: "3.11"
+            python-version: "3.10"
           - os: windows-latest
-            python-version: "3.11"
-
+            python-version: "3.10"
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: pip install .[test,dev]
-
-      - name: Check static typing
-        run: mypy sphinxcontrib
-
+      - name: Install nox
+        run: pip install nox
       - name: test with pytest
-        run: pytest --color=yes --cov --cov-report=xml tests
+        run: nox -s test
 
-      - name: coverage
-        run: coverage xml
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install nox
+        run: pip install nox
+      - name: Build docs
+        run: nox -s docs
 
+  coverage:
+    needs: [build]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install nox and coverage
+        run: pip install nox
+      - name: test with pytest
+        run: nox -s test
       - name: codecov
         uses: codecov/codecov-action@v3
         with:

noxfile.py

@@ -2,6 +2,7 @@
 
 The nox run are build in isolated environment that will be stored in .nox. to force the venv update, remove the .nox/xxx folder.
 """
+from pathlib import Path
 
 import nox
 
@@ -11,27 +12,28 @@ def docs(session):
     """Build the documentation."""
     session.install(".[doc]")
     b = session.posargs[0] if session.posargs else "html"
-    session.run("sphinx-build", f"-b={b}", "-a", "-E", "docs", f"docs/_build/{b}")
+    dst = Path(__file__).parent / "docs" / "_build" / b
+    session.run("sphinx-build", f"-b={b}", "-a", "-E", "docs", str(dst))
 
 
 @nox.session(reuse_venv=True)
 def lint(session):
     """Apply the pre-commits."""
     session.install("pre-commit")
-    session.run("pre-commit", "run", "-a", *session.posargs)
+    session.run("pre-commit", "run", "--all-files")
 
 
 @nox.session(reuse_venv=True)
 def mypy(session):
     """Run a mypy check of the lib."""
-    session.install(".[dev]")
+    session.install("mypy")
     test_files = session.posargs or ["sphinxcontrib"]
     session.run("mypy", *test_files)
 
 
 @nox.session(reuse_venv=True)
 def test(session):
     """Run all the test using the environment varialbe of the running machine."""
-    session.install(".[test]")
-    test_files = session.posargs or ["tests"]
-    session.run("pytest", "--color=yes", "--cov", "--cov-report=html", *test_files)
+    session.install("--verbose", ".[test]")
+    # session.run("pytest", "--color=yes", "--cov", "--cov-report=html", *test_files)
+    session.run("sphinx-build", "--bug-report")

pyproject.toml

@@ -40,9 +40,21 @@ content-type = "text/x-rst"
 repository = "https://github.com/sphinx-contrib/icon"
 
 [project.optional-dependencies]
-dev = ["nox", "pre-commit", "mypy"]
-test = ["pytest", "beautifulsoup4", "pytest-regressions", "pytest-cov"]
-doc = ["pydata-sphinx-theme==0.13.0rc3", "sphinx-design", "sphinx-copybutton"]
+dev = [
+    "nox",
+    "pre-commit",
+]
+test = [
+    "pytest",
+    "beautifulsoup4",
+    "pytest-regressions",
+    "pytest-cov"
+]
+doc = [
+    "pydata-sphinx-theme",
+    "sphinx-design",
+    "sphinx-copybutton"
+]
 
 [tool.setuptools]
 include-package-data = false

setup.py

@@ -1,3 +1,4 @@
+import platform
 from pathlib import Path
 
 from pynpm import NPMPackage
@@ -8,6 +9,10 @@
 
 ROOT = Path(__file__).parent
 
+# create a global variable to check if we are on windows
+# to pilot the shell option to run the tests
+is_windows = platform.system() == "Windows"
+
 
 def update_package_data(distribution) -> None:
     """Update package_data to catch changes during setup."""
@@ -43,7 +48,8 @@ def finalize_options(self):
 
     def run(self):
         """Run the command."""
-        NPMPackage(ROOT / "sphinxcontrib" / "icon" / "package.json").install()
+        package = ROOT / "sphinxcontrib" / "icon" / "package.json"
+        NPMPackage(str(package), shell=is_windows).install()
         update_package_data(self.distribution)
 
 

sphinxcontrib/icon/__init__.py

@@ -22,6 +22,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     font_handler = Fontawesome()
 
     # install html related files
+    raise Exception(str(font_handler.css_file.resolve()))
     app.add_css_file(str(font_handler.css_file.resolve()))
     app.add_js_file(str(font_handler.js_file.resolve()))
 

sphinxcontrib/icon/font_handler.py

@@ -43,7 +43,7 @@ def add_latex_font_files(self, app: Sphinx) -> None:
             dst = Path(app.builder.outdir) / f.name
             logger.info(f"Writing: {f.name}")
             ensuredir(app.builder.outdir)
-            copyfile(str(f.resolve()), str(dst.resolve()))
+            copyfile(str(f), str(dst))
 
     def add_latex_font(self, app: Sphinx, config: Config) -> None:
         """Add the fontawesome fontfamily in the preamble of the .tex file."""