Fix tox docs job (#550)

* Fix tox docs job

* Clean up tox.ini

* Remove browser invocation from `make docs`

Author: Tinche

Makefile

@@ -66,16 +66,12 @@ coverage: ## check code coverage quickly with the default Python
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/cattr.rst
-	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ src/cattr
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs doctest
 	$(MAKE) -C docs html
-	$(BROWSER) docs/_build/html/index.html
 
-servedocs: docs ## compile the docs watching for changes
-	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+htmllive: docs ## compile the docs watching for changes
+	$(MAKE) -C docs htmllive
 
 bench-cmp:
 	pytest bench --benchmark-compare

README.md

@@ -4,17 +4,18 @@
   <em>Great software needs great data structures.</em>
 </p>
 
-<a href="https://pypi.python.org/pypi/cattrs"><img src="https://img.shields.io/pypi/v/cattrs.svg"/></a>
-<a href="https://github.com/python-attrs/cattrs/actions?workflow=CI"><img src="https://github.com/python-attrs/cattrs/workflows/CI/badge.svg"/></a>
-<a href="https://catt.rs/en/latest/?badge=latest"><img src="https://readthedocs.org/projects/cattrs/badge/?version=latest" alt="Documentation Status"/></a>
-<a href="https://github.com/python-attrs/cattrs"><img src="https://img.shields.io/pypi/pyversions/cattrs.svg" alt="Supported Python versions"/></a>
-<a href="https://github.com/python-attrs/cattrs/actions/workflows/main.yml"><img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Tinche/22405310d6a663164d894a2beab4d44d/raw/covbadge.json"/></a>
-<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg"/></a>
+[![PyPI](https://img.shields.io/pypi/v/cattrs.svg)](https://pypi.python.org/pypi/cattrs)
+[![Build](https://github.com/python-attrs/cattrs/workflows/CI/badge.svg)](https://github.com/python-attrs/cattrs/actions?workflow=CI)
+[![Documentation Status](https://readthedocs.org/projects/cattrs/badge/?version=latest)](https://catt.rs/)
+[![Supported Python Versions](https://img.shields.io/pypi/pyversions/cattrs.svg)](https://github.com/python-attrs/cattrs)
+[![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Tinche/22405310d6a663164d894a2beab4d44d/raw/covbadge.json)](https://github.com/python-attrs/cattrs/actions/workflows/main.yml)
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 ---
 
-**cattrs** is an open source Python library for structuring and unstructuring
-data. _cattrs_ works best with _attrs_ classes, dataclasses and the usual
+**cattrs** is an open source Python library for structuring and unstructuring data.
+_cattrs_ works best with _attrs_ classes, dataclasses and the usual
 Python collections, but other kinds of classes are supported by manually
 registering converters.
 

docs/customizing.md

@@ -255,10 +255,13 @@ To only un/structure _some_ named tuples into dictionaries,
 change the predicate function when registering the hook factory:
 
 ```{doctest} namedtuples
+    :options: +ELLIPSIS
+
 >>> c.register_unstructure_hook_factory(
 ...     lambda t: t is MyNamedTuple,
 ...     namedtuple_dict_unstructure_factory,
 ... )
+<function namedtuple_dict_unstructure_factory at ...>
 ```
 
 ## Using `cattrs.gen` Generators

tox.ini

@@ -4,12 +4,12 @@ python =
     3.8: py38
     3.9: py39
     3.10: py310
-    3.11: py311
+    3.11: py311, docs
     3.12: py312, lint
     pypy-3: pypy38
 
 [tox]
-envlist = pypy38, py38, py39, py310, py311, py312, lint
+envlist = pypy38, py38, py39, py310, py311, py312, lint, docs
 isolated_build = true
 skipsdist = true
 
@@ -55,9 +55,10 @@ commands_pre =
 basepython = python3.11
 setenv =
     PYTHONHASHSEED = 0
-deps =
-    sphinx
-    zope.interface
+commands_pre =
+    pdm sync -G :all,docs
 commands =
     make docs
-allowlist_externals = make
+allowlist_externals =
+    make
+    pdm