sphinx-autodoc2

sphinx-autodoc2 copied to clipboard

When `autodoc2_module_summary = False`, each module's page only includes the "Submodules" heading at the top and no other API documentation. I assume this is unintended, and the "summary" being referenced...

davidselassie

It looks like when enumerating through the nested children of a class, the code also needs to list out exceptions. Adds test. Should fix what I found in https://github.com/sphinx-extensions2/sphinx-autodoc2/issues/51

davidselassie

Question: remove module name from path

2

Hello, First, thanks for your work! Do you know if it's possible to remove the full name from a class or function reference? As shown below, it's even more bizarre...

jeertmans

I have an exception defined as a nested inner class. It ends up being missing from the resulting documentation. Other exceptions and other nested inner classes do appear, though. ```python...

davidselassie

Comparison with sphinx-autoapi?

2

This project seems similar to https://github.com/readthedocs/sphinx-autoapi. It'd be nice to have a comparison.

auscompgeek

Fix example of `autodoc2_replace_annotations` and `autodoc2_replace_bases` to specify `list[tuple[int, int]]`.

lan496

Class variable intialized with object: value rendered as None

1

Great work! I'm converting a project from autodoc, and loving the improvements... Came across this, its a bit of a show-stopper: Code like this: ``` class Foo: """I'm a Foo"""...

powderflask

Support for NumPy-style docstrings

12

Is there a way to make `autodoc2` work with NumPy-style docstrings?

ma-sadeghi

Currently I can't seem to get sphinx-autodoc2 to generate the signature for overloaded functions. **Example** ```python from typing import overload @overload() def myfunc(a: int): """foobar with int""" ... @overload() def...

ketozhang

I am using sphinx2-autodoc2 to generate documentation for a Python class like this: ```python class Foo: """This is class foo""" bar = 42 """The bar of foo""" ``` When running...

johanseland