sphinx-autoapi

sphinx-autoapi copied to clipboard

At what point would localization happen in the generation process, and how can we make contribution to localization on generated documentation an open source effort?

agjohnson

Here is an example scenario: ```python # mypackage/__init__.py from ._submodule import func, PublicClass __all__ = ("func", "PublicClass") # mypackage/_submodule.py class PublicClass: pass def func(a: PublicClass) -> bool: return True ```...

AWhetter

Hi, I am in need for some module docstring post-processing, and it took me rather long to figure out that: 1. `autoapi` also allows (some?) `autodoc-*` events to be captured...

Josverl

There have been some recent releases of `sphinx-autoapi` which are available on PyPI but the [conda-forge feedstock](https://github.com/conda-forge/sphinx-autoapi-feedstock) is unfortunately a few releases behind. Please could a core dev update the...

bjlittle

Hook for modifying method signatures

8

Thanks for this plugin, it's really great! I have a package which uses a class decorator to modify some methods of a class. Specifically it wraps coroutines in a sync...

jacobtomlinson

Mark tests that use the network

2

These two tests uses intersphinx, and the marker allows skipping them if there is no network available.

QuLogic

Hi. I found that when using autodoc typehints, the "Parameters" field from `__init__()` is duplicated in the class but without the descriptions. The return type is omitted in the class,...

hanetar

Autoapi only considers the first line for docstrings starting with a directive

6

So, `.. note:: This is a test` is processed correctly in docstrings. but ``` .. note:: This is a test ``` is not working. ``` Something else. .. note:: This...

eymeric-giraux

Difference between submodules and subpackages?

1

I'm trying to use `autoapi` to document a package, and am getting the API docs grouped in both "submodules" and "subpackages": Does anyone know 1. The difference between a submodule...

dstansby

Griffe backend

1

We currently implement a custom parser using astroid. While this allows us to fix issues as needed, we may be able to get faster and more frequent fixes by utilising...

AWhetter