sphinx-autodoc2
sphinx-autodoc2 copied to clipboard
A Sphinx extension that automatically generates API documentation for your Python packages.
I'm getting the following when trying to build our docs with `sphinx-autodoc2`: ``` [Autodoc2] Determining files to write ... [Autodoc2] Writing modules...[ 0%] src Traceback (most recent call last): File...
I am entirely new to Sphinx so this could just be a PEBKAC, but I've not managed to find a solution after quite a bit of searching. When documenting a...
[autodoc_class_signature ](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_class_signature) This value selects how the signature will be displayed for the class defined by [autoclass](https://www.sphinxdoc.org/en/master/usage/extensions/autodoc.html#directive-autoclass) directive. The possible values are: "mixed" Display the signature with the class name....
updates: - [github.com/pre-commit/pre-commit-hooks: v4.6.0 → v5.0.0](https://github.com/pre-commit/pre-commit-hooks/compare/v4.6.0...v5.0.0) - [github.com/astral-sh/ruff-pre-commit: v0.4.4 → v0.11.9](https://github.com/astral-sh/ruff-pre-commit/compare/v0.4.4...v0.11.9) - [github.com/pre-commit/mirrors-mypy: v1.10.0 → v1.15.0](https://github.com/pre-commit/mirrors-mypy/compare/v1.10.0...v1.15.0)
I am hoping to use sphinx-autodoc2 to document [PEP 420](https://peps.python.org/pep-0420/) namespace packages. These are packages which are assembled together via multiple "distributions" which each provide a submodule within the namespace...
When reading and copying the code blocks a user makes the mistake of giving a dict and not the needed list resulting in an warning thrown. https://github.com/sphinx-extensions2/sphinx-autodoc2/blob/1f55a8872cccd235cafa6323e2ae8c3a563156f4/docs/quickstart.md?plain=1#L106
I found a couple of issues with PR #69, so I decided to rebase on the latest master and fix both issues. I would love to see this merged. Is...
I am not quite sure how to resolve the `mypy` feedback. % `pre-commit autoupdate` % ` pre-commit run --all-files` ``` mypy.....................................................................Failed - hook id: mypy - exit code: 1 src/autodoc2/sphinx/extension.py:45:...