docs: cleanup (#567)

* fix: support docs/tests extras, simpler RtD install

Use oldest-supported-numpy from SciPy in example

* chore: bump to ubuntu-20.04 images

* fix: move extras to setup so we can do combinations

.gitignore

@@ -106,4 +106,11 @@ env3?/
 # MyPy cache
 .mypy_cache/
 
+# Output cache for setup.py checker
 all_known_setup.yaml
+
+# mkdocs
+site/
+
+# Virtual environments
+venv*

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
   rev: 20.8b1
   hooks:
   - id: black
-    files: ^bin/update_pythons.py$
+    files: ^bin/update_pythons.py|setup.py$
 
 - repo: https://github.com/pre-commit/mirrors-mypy
   rev: v0.800

.readthedocs.yml

@@ -6,9 +6,9 @@ mkdocs:
   configuration: mkdocs.yml
 
 python:
-  version: 3.7
+  version: 3.8
   install:
     - method: pip
       path: .
       extra_requirements:
-        - dev
+        - docs

docs/options.md

@@ -356,27 +356,26 @@ CIBW_BEFORE_BUILD: "{package}/script/prepare_for_build.sh"
 ```
 
 !!! note
-    If you need dependencies installed for the build, we recommend using pyproject.toml. This is an example pyproject.toml file:
+    If you need dependencies installed for the build, we recommend using
+    `pyproject.toml`. This is an example `pyproject.toml` file:
 
         [build-system]
         requires = [
             "setuptools>=42",
             "wheel",
             "Cython",
-            "numpy==1.11.3; python_version<='3.6'",
+            "numpy==1.13.3; python_version<'3.5'",
-            "numpy==1.14.5; python_version=='3.7'",
+            "oldest-supported-numpy; python_version>='3.5'",
-            "numpy==1.17.3; python_version=='3.8'",
-            "numpy==1.19.4; python_version>='3.9'",
         ]
 
         build-backend = "setuptools.build_meta"
 
-    This [PEP 517][]/[PEP 518][] style build allows you to completely control the
+    This [PEP 517][]/[PEP 518][] style build allows you to completely control
-    build environment in cibuildwheel, [PyPA-build][], and pip, doesn't force
+    the build environment in cibuildwheel, [PyPA-build][], and pip, doesn't
-    downstream users to install anything they don't need, and lets you do more
+    force downstream users to install anything they don't need, and lets you do
-    complex pinning (Cython, for example, requires a wheel to be built with an
+    more complex pinning (Cython, for example, requires a wheel to be built
-    equal or earlier version of NumPy; pinning in this way is the only way to
+    with an equal or earlier version of NumPy; pinning in this way is the only
-    ensure your module works on all available NumPy versions).
+    way to ensure your module works on all available NumPy versions).
 
     [PyPA-build]: https://pypa-build.readthedocs.io/en/latest/
     [PEP 517]: https://www.python.org/dev/peps/pep-0517/

examples/github-deploy.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-18.04, windows-2019, macos-10.15]
+        os: [ubuntu-20.04, windows-2019, macos-10.15]
 
     steps:
       - uses: actions/checkout@v2

examples/github-minimal.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-18.04, windows-2019, macos-10.15]
+        os: [ubuntu-20.04, windows-2019, macos-10.15]
 
     steps:
       - uses: actions/checkout@v2

examples/github-with-qemu.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-18.04, windows-2019, macos-10.15]
+        os: [ubuntu-20.04, windows-2019, macos-10.15]
 
     steps:
       - uses: actions/checkout@v2

requirements-dev.txt

@@ -1 +1 @@
--e .[dev]
+-e .[dev,docs]

setup.cfg

@@ -38,23 +38,6 @@ install_requires =
 [options.package_data]
 cibuildwheel = resources/*
 
-[options.extras_require]
-dev =
-    click
-    mkdocs-include-markdown-plugin==2.1.1
-    mkdocs==1.0.4
-    pip-tools
-    pygithub
-    ghapi
-    pymdown-extensions
-    pytest>=4
-    pytest-timeout
-    pyyaml
-    requests
-    typing-extensions
-    rich>=9.6
-    mypy>=0.800
-
 [options.packages.find]
 include =
     cibuildwheel

setup.py

@@ -1,3 +1,31 @@
 from setuptools import setup
 
-setup()
+extras = {
+    "docs": [
+        "mkdocs-include-markdown-plugin==2.1.1",
+        "mkdocs==1.0.4",
+        "pymdown-extensions",
+    ],
+    "test": [
+        "jinja2",
+        "pytest>=4",
+        "pytest-timeout",
+    ],
+    "dev": [
+        "click",
+        "ghapi",
+        "mypy>=0.800",
+        "packaging>=20.8",
+        "pip-tools",
+        "pygithub",
+        "pyyaml",
+        "requests",
+        "rich>=9.6",
+        "typing-extensions",
+    ],
+}
+
+extras["all"] = sum(extras.values(), [])
+extras["dev"] += extras["test"]
+
+setup(extras_require=extras)