FIX(build,site,TC) import sphinx & call (vs build_sphinx); >

- fix(build) add build-backend in pyproject.toml,
  reported a missing when pip-installing project.
- DROP(CI) site step (since it's included by `pytest`).
- drop(build) `sphinx[setuptools]` never really worked, and now is
  missing.

Author: ankostis

.github/workflows/ci.yaml

@@ -49,10 +49,6 @@ jobs:
         #   fail_ci_if_error: true # optional (default = false)
         #   verbose: true # optional (default = false)
 
-      - name: site
-        run: |
-          python setup.py build_sphinx
-
       - name: build
         run: |
           python -m build

bin/build.sh

@@ -2,5 +2,5 @@
 
 # clean, or invalid files in packages
 rm -vrf ./build/* ./dist/* ./*.pyc ./*.tgz ./*.egg-info
-python setup.py sdist bdist_wheel
-
+python -m build
+sphinx-build -Wj auto -D graphtik_warning_is_error=true docs/source/ docs/build/

docs/source/conf.py

@@ -97,6 +97,7 @@ def _make_py_item_url(fn):
             return f"../reference.html#{fn_name}"
 
 
+graphtik_warning_is_error = False
 plotter = plot.get_active_plotter()
 plot.set_active_plotter(
     plotter.with_styles(

pyproject.toml

@@ -1,5 +1,6 @@
 [build-system]
-requires = ["setuptools>=30.3.0", "build"]
+requires = ["setuptools>=30.3.0"]
+build-backend = "setuptools.build_meta"
 
 [tool.black]
 ## Also `.gitignore` is sourced.

requirements.txt

@@ -17,13 +17,17 @@ bleach==6.0.0
 boltons==23.0.0
     # via graphtik (setup.py)
 build==0.10.0
-    # via graphtik (setup.py)
+    # via
+    #   graphtik (setup.py)
+    #   pip-tools
 certifi==2022.12.7
     # via requests
 charset-normalizer==3.1.0
     # via requests
 click==8.1.3
-    # via black
+    # via
+    #   black
+    #   pip-tools
 contourpy==1.0.7
     # via matplotlib
 coverage[toml]==7.2.3
@@ -63,7 +67,9 @@ markupsafe==2.1.2
     #   graphtik (setup.py)
     #   jinja2
 matplotlib==3.7.1
-    # via graphtik (setup.py)
+    # via
+    #   graphtik (setup.py)
+    #   sphinxext-opengraph
 mccabe==0.7.0
     # via pylint
 mypy==1.2.0
@@ -72,7 +78,7 @@ mypy-extensions==1.0.0
     # via
     #   black
     #   mypy
-networkx==3.1 ; python_version >= "3.5"
+networkx==3.1
     # via graphtik (setup.py)
 numpy==1.24.3
     # via
@@ -93,6 +99,8 @@ pathspec==0.11.1
     # via black
 pillow==9.5.0
     # via matplotlib
+pip-tools==6.13.0
+    # via graphtik (setup.py)
 platformdirs==3.4.0
     # via
     #   black
@@ -144,10 +152,11 @@ six==1.16.0
     #   python-dateutil
 snowballstemmer==2.2.0
     # via sphinx
-sphinx[setuptools]==6.2.1
+sphinx==6.2.1
     # via
     #   graphtik (setup.py)
     #   sphinxcontrib-spelling
+    #   sphinxext-opengraph
 sphinxcontrib-applehelp==1.0.4
     # via sphinx
 sphinxcontrib-devhelp==1.0.2
@@ -162,6 +171,8 @@ sphinxcontrib-serializinghtml==1.1.5
     # via sphinx
 sphinxcontrib-spelling==8.0.0
     # via graphtik (setup.py)
+sphinxext-opengraph==0.8.2
+    # via graphtik (setup.py)
 termcolor==2.3.0
     # via pytest-sugar
 tomlkit==0.11.7
@@ -176,5 +187,11 @@ webencodings==0.5.1
     # via
     #   bleach
     #   html5lib
+wheel==0.40.0
+    # via pip-tools
 wrapt==1.15.0
     # via astroid
+
+# The following packages are considered to be unsafe in a requirements file:
+# pip
+# setuptools

setup.py

@@ -52,7 +52,7 @@ def _ask_git_version() -> Optional[str]:
     "MarkupSafe",
 ]
 matplot_deps = plot_deps + ["matplotlib"]
-sphinx_deps = plot_deps + ["sphinx[setuptools] >=2", "sphinxext-opengraph"]
+sphinx_deps = plot_deps + ["sphinx >=2", "sphinxext-opengraph"]
 test_deps = list(
     set(
         matplot_deps

test/test_site.py

@@ -70,11 +70,22 @@ def test_README_as_PyPi_landing_page(monkeypatch):
 
 
 def test_sphinx_html(monkeypatch):
+    from sphinx.cmd import build
+
     # Fail on warnings, but don't rebuild all files (no `-a`),
     # rm -r ./build/sphinx/ # to fully test site.
-    site_args = list("setup.py build_sphinx -W".split())
+    build_options = [
+        "-W",
+        # "-E",
+        "-D",
+        "graphtik_warning_is_error=true",
+        "--color",
+        "-j",
+        "auto",
+    ]
     if logging.getLogger(__name__).isEnabledFor(logging.INFO):
-        site_args.append("-v")
-    monkeypatch.setattr(sys, "argv", site_args)
+        build_options.append("-v")
+    site_args = [*build_options, "docs/source/", "docs/build"]
     monkeypatch.chdir(proj_path)
-    importlib.import_module("setup")
+    ret = build.build_main(site_args)
+    assert not ret