sphinx-autoapi

sphinx-autoapi copied to clipboard

I noticed this warning when developing [the docs in pyMOR](https://github.com/pymor/pymor/pull/1563). In the `index.rst` in `pymor.algorithms/timestepping` I get the warnings below. The warning originates in the docstring of the `solve` method....

MagnusOstertag

As per title: directive `.. autoapiclass` does not respect `autoapi_member_order = "bysource"`, and I'm not sure if there are others. Here is a minimal working example: https://github.com/astrojuanlu/sphinx-autoapi-debug/tree/033f68fd Even though `testpkg.A`...

astrojuanlu

Python `module.rst` top-level section headers get eaten by Sphinx

3

I'm not sure what I'm doing differently (as I'm sure this would've been spotted by someone else much sooner), but top-level section headers are being swallowed by Sphinx. Combined with...

TeoZosa

`Cannot resolve import` on re-imported class from module.

3

In airflow we like to run with `-W` flag (to turn warnings in to errors) and we are "stuck" on 1.0.0 for various reasons. (One day soon we'll be able...

ashb

(Please let me know if the title could be improved) I have a class C defined in submodule B of module A, so full python name would be `A.B.C`. But...

MatthijsBurgh

I'm building documentation for my python package and some of my classes have class-level attributes. These can sometimes take the value of dictionaries, or python enums. I was trying to...

freddyaboulton

Module table of contents are poorly formatted when long type hints are present

2

When a function has a very long call signature, potentially because it's making extensive use of type hints, the module table of contents generated by AutoAPI ends up being poorly...

zaneselvans

Problem conditionally defined/generated objects?

5

It seems conditionally defined objects are not handled correctly. [Example file](https://github.com/pymor/pymor/blob/main/src/pymor/core/pickle.py#L43) ``` Traceback (most recent call last): File "/usr/local/lib/python3.8/site-packages/sphinx/cmd/build.py", line 276, in build_main app = Sphinx(args.sourcedir, args.confdir, args.outputdir, File "/usr/local/lib/python3.8/site-packages/sphinx/application.py",...

renefritze

Extendable templates?

2

In my local `python/module.rst` I only need to override one block of the default template. ``` {% extends "python/module.rst" %} {% block functions scoped %} {% endblock %} ``` That...

renefritze

Warning prompts the position of .rst file rather than .py file

3

Is there anyway for me to overwrite the `map()` function in `mappers/python/mapper.py`?

tyuanhang