readthedocs sphinx-autoapi issues

readthedocs / sphinx-autoapi

A new approach to API documentation in Sphinx.

https://sphinx-autoapi.readthedocs.io/

MIT License

413 stars 126 forks source link

issues

Newest

Newest Most commented Recently updated Oldest Least commented Least recently updated

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

#458 eymeric-giraux opened 6 days ago
0
Fix warning about using srcdir as a string

#457 AWhetter closed 1 week ago
0
Cannot omit undoc-members when specifying options

#456 mfncooper closed 1 week ago
2
Fix _static paths getting corrupted during RST generation

#455 sachahu1 closed 1 week ago
1
html_static_path variable doesn't work as expected due to RST nesting.

#454 sachahu1 closed 1 week ago
2
Never skip modules and packages

#453 sachahu1 opened 2 weeks ago
1
AutoAPI identifies imported class as an ambiguous cross-reference target in v3.1.0 and v3.1.1

#452 zaneselvans closed 1 week ago
5
Undocumented instance attributes are ignored even with "undoc-members" selected

#451 hanetar closed 1 week ago
1
Difference between submodules and subpackages?

#450 dstansby opened 1 month ago
1
3.1.1: `pyupgrade --py38-plush` generated changes trashes test suite

#449 kloczek closed 1 week ago
1
Issue in 3.1.1: Handler <function run_autoapi at 0x7c590c5005e0> for event 'builder-inited' threw an exception (exception: [Errno 2] No such file or directory

#448 castlez opened 1 month ago
5
`sphinx-autoapi==3.1.0` fails to properly handle Python imports

#447 odimko closed 1 month ago
6
Private packages cause toctree warning since v3.1.0

#446 eigenbrot closed 1 month ago
1
Addressing Warning ``unpickable configuration value`` with Sphinx 7.3.7 Update

#445 Revathyvenugopal162 closed 1 month ago
0
Griffe backend

#444 AWhetter opened 1 month ago
1
Remove Attributes + classes show no description

#443 Gabriel-p opened 1 month ago
3
How to cross-reference to `sphinx-autoapi` generated pages?

#442 michaelweinold closed 1 month ago
1
ERROR: Could not import extension autoapi.sphinx (exception: No module named 'autoapi') when attempting to build docs

#441 calebregg52 closed 1 week ago
3
Consistent "dictionary changed size during iteration" exception

#439 fmigneault closed 1 month ago
2
Configuration callback is causing warnings with sphinx >= 7.3.0

#438 dhalbert closed 2 months ago
1
Treat methods decorated with `functools.cached_property` as properties

#436 michellewang closed 1 week ago
0
__all__ doesn't seem to be respected

#435 wbthomason closed 1 month ago
2
Alpha version `3.1.0a4` was released as `3.0.0a4`

#434 burgholzer closed 2 months ago
1
Add test and docs extra dependencies to devcontainer

#433 arwedus opened 2 months ago
0
fix: Correctly include templates API docs

#432 arwedus closed 1 week ago
1
feat: Add warning for missing import

#431 arwedus opened 2 months ago
0
KeyError: preventing docs building

#430 HKaras opened 2 months ago
3
Parses first element of if __name__ == '__main__' block

#429 jsatuit opened 2 months ago
0
Fix warning about returning tuples from `get_object_members()`

#428 AWhetter closed 1 week ago
0
how to customize titles of the generated pages ?

#427 12rambau closed 2 months ago
3
drop setup.cfg ?

#426 12rambau opened 3 months ago
1
Enable strict type checking

#425 AWhetter opened 3 months ago
0
Replace usage of deprecated docutils.nodes.Node.traverse

#424 GeeTransit closed 3 months ago
1
Preserve strings inside Literal type annotations

#423 GeeTransit closed 3 months ago
1
Sphinx Viewcode and autoapi conflict: IndexError list index out of range if child class file (.py) is smaller than parent class file.

#422 hansonmcoombs closed 3 weeks ago
2
Anybody having issues with numpydoc?

#421 HealthyPear opened 4 months ago
0
What is generated exactly?

#420 HealthyPear closed 4 months ago
3
Add warning message for unresolved python elements

#419 arwedus opened 4 months ago
3
3.0.0: file list conflict between `sphinx-autoapi` and `autoapi`

#418 kloczek closed 4 months ago
2
Allow finer-grained control over display of inherited members

#417 td-anne opened 4 months ago
4
Implementing a nightly build worklfow

#416 jorgepiloto opened 5 months ago
0
Using original module.rst as custom template throws errors

#415 f-fuchs closed 6 months ago
1
Add support for type aliases introduced in Python 3.12 via PEP 695

#414 Stausssi opened 7 months ago
3
How to sort TOC entries

#413 jdumas opened 7 months ago
0
Extension error: list index out of range

#412 mcflugen closed 4 months ago
5
Make imported memebrs link to their documentation.

#411 ShaiAvr opened 7 months ago
3
AttributeError: 'Module' object has no attribute 'doc'

#410 12rambau closed 7 months ago
5
Add Reference section guide in how_to.rst

#409 JSS95 closed 6 months ago
0
Replace usage of deprecated astroid.NodeNG.doc in inheritance_diagram

#408 BrandonWiebe closed 9 months ago
0
sphinx-autoapi fails with astroid 3.0.0

#407 zaneselvans closed 9 months ago
2