sphinx-autodoc2 icon indicating copy to clipboard operation
sphinx-autodoc2 copied to clipboard

A Sphinx extension that automatically generates API documentation for your Python packages.

Results 35 sphinx-autodoc2 issues
Sort by recently updated
recently updated
newest added

For type aliases, one can either use the 3.12 syntax: ```python type Resolves[T] = T | OutputOf ``` which results in an error: `WARNING: ralsei.graph.outputof: ralsei.graph.outputof: 'Resolves' is unknown [autodoc2.all_resolve]`...

I am using [lazy-loader](https://github.com/scientific-python/lazy-loader) for lazy importing. However, I found that [sphinx-autdoc2](https://github.com/sphinx-extensions2/sphinx-autodoc2) cannot generate docs for lazily imported functions, classes, etc. Here is a simple [demo](https://github.com/liblaf/hello-sphinx-autodoc2) where docs for normal...

The small project explained below shows this warning message when built with `sphinx-build -M html . _build`: ``` WARNING: /home/gabriel/Descargas/sphinx_temp/docs/testpack/test.py:-27: (WARNING/2) Inline literal start-string without end-string. [docutils] ``` Line `-27`...

I have tried with both explicit `autodoc2_class_inheritance = True` in my `conf.py` and without it, but no inheritance diagrams are generated. Is there other way to generate the class inheritance?...

I wanted to use autodoc2 to create documentation for the code in https://pypi.org/project/gitea/1.0.0/ But autodoc2 crashed with a stacktrace, see the attached log. My setup is as follows: * I...