readthedocs/sphinx-autoapi

View on GitHub

A Sphinx extension for generating API documentation without importing the API.

Stars: 494
Forks: 147
Open beginner issues: 0
Indexed issues: 58
Avg merge: 9m
Merged PRs (30d): 1

Dominant language: Python
License: MIT
Last GitHub push: Aug 23, 2026
Latest indexed: Sep 19, 2026
Contributing guide: No contributing guide
Code of conduct: No code of conduct
Beginner labels: good first issue

Beginner friendly Everything

Open All

58 open issues indexed

test_symlink is broken from the sdist Open

Difficulty 3/5 1-2 days Newbie friendliness 62/100

readthedocs/sphinx-autoapi#565 · 1 comment · Opened Jun 27, 2026
First overload of functions with multiple overloads in .pyi files fail to appear in resultant .html Open

Difficulty 4/5 3-5 days Newbie friendliness 48/100

readthedocs/sphinx-autoapi#557 · 2 comments · Opened Apr 5, 2026
PEP695 generic type syntax interpretion as cross-reference Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#552 · Opened Feb 12, 2026
Types from attrs.define classes not shown in description Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

readthedocs/sphinx-autoapi#551 · 1 comment · 1 reaction · Opened Jan 30, 2026
`imported-members` and `show-inheritance` leads to broken links Open

Difficulty 4/5 3-5 days Newbie friendliness 45/100

readthedocs/sphinx-autoapi#546 · Opened Nov 24, 2025
WARNING: Unknown type: placeholder Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#540 · 6 comments · Opened Oct 14, 2025
Allow separate documentation for class and `__init__` constructor Open

Good First Issue

Difficulty 3/5 1-2 days Newbie friendliness 45/100

readthedocs/sphinx-autoapi#532 · 4 comments · 2 reactions · Opened Aug 28, 2025
Bad construction of return type in `AutoapiSummary` leads to bad signature mangling with autodoc Open

Difficulty 2/5 1-3 hours Newbie friendliness 48/100

readthedocs/sphinx-autoapi#531 · Opened Aug 28, 2025
Adding better support for pydantic models Open

Difficulty 5/5 Over a week Newbie friendliness 35/100

readthedocs/sphinx-autoapi#529 · 3 comments · 1 reaction · Opened Aug 6, 2025
`add_module_names = False` doesn't affect toctrees, only the body Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#527 · 2 comments · 1 reaction · Opened Jul 11, 2025
Indirect imports not supported Open

Needed: Design Decision

Difficulty 3/5 1-2 days Newbie friendliness 48/100

readthedocs/sphinx-autoapi#524 · 1 comment · Opened May 20, 2025
Show source from private modules Open

Needed: Reproduction Case

Difficulty 4/5 3-5 days Newbie friendliness 45/100

readthedocs/sphinx-autoapi#515 · 2 comments · Opened Mar 5, 2025
3.4.0 borks inheritance diagrams of classes with `namedtuple` class variables Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#505 · 1 comment · Opened Dec 2, 2024
Custom Template - Something is not working at all Open

Difficulty 4/5 3-5 days Newbie friendliness 25/100

readthedocs/sphinx-autoapi#494 · Opened Oct 18, 2024
Option to disable docstring inheritance Open

Difficulty 4/5 3-5 days Newbie friendliness 38/100

readthedocs/sphinx-autoapi#489 · 3 comments · 4 reactions · Opened Oct 9, 2024
Add a template for testing Open

Difficulty 2/5 1-3 hours Newbie friendliness 48/100

readthedocs/sphinx-autoapi#487 · Opened Oct 1, 2024
Intersphinx typehints are not properly parsed Open

Difficulty 4/5 3-5 days Newbie friendliness 38/100

readthedocs/sphinx-autoapi#483 · 1 comment · 1 reaction · Opened Sep 24, 2024
Sphinx Build fails on `AttributeError: 'AssignName' object has no attribute 'getattr'` Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#480 · 2 comments · Opened Sep 5, 2024
[Bug] Not working with `lazy-loader` Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#479 · Opened Aug 31, 2024
Sphinx AutoAPI >=3.2 generates duplicate definitions of class attributes Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#476 · 9 comments · 1 reaction · Opened Aug 9, 2024
References to hidden members remain unresolved when a documented alternative exists Open

Difficulty 4/5 3-5 days Newbie friendliness 45/100

readthedocs/sphinx-autoapi#469 · Opened Jul 26, 2024
add documentation for availability and differences for `autodoc-process-docstring` (and some friends) Open

Difficulty 2/5 1-3 hours Newbie friendliness 48/100

readthedocs/sphinx-autoapi#468 · Opened Jul 24, 2024
Duplicated annotations in class and __init__() with autodoc typehints Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#461 · 1 reaction · Opened Jul 6, 2024
Hook for modifying method signatures Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#459 · 8 comments · Opened Jul 1, 2024
Griffe backend Open

readthedocs/sphinx-autoapi#444 · 5 comments · 1 reaction · 1 assignee · Opened May 8, 2024
Remove Attributes + classes show no description Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#443 · 3 comments · Opened May 7, 2024
Parses first element of if __name__ == '__main__' block Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

readthedocs/sphinx-autoapi#429 · Opened Apr 3, 2024
Enable strict type checking Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

readthedocs/sphinx-autoapi#425 · Opened Mar 26, 2024
Allow finer-grained control over display of inherited members Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

readthedocs/sphinx-autoapi#417 · 5 comments · 3 reactions · Opened Feb 6, 2024
Implementing a nightly build worklfow Open

Difficulty 2/5 1-3 hours Newbie friendliness 50/100

readthedocs/sphinx-autoapi#416 · Opened Jan 18, 2024
How to sort TOC entries Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#413 · Opened Nov 28, 2023
Make imported memebrs link to their documentation. Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#411 · 3 comments · 1 reaction · Opened Nov 7, 2023
Wrong namespace resolution for base clases when using star import Open

Difficulty 3/5 1-2 days Newbie friendliness 48/100

readthedocs/sphinx-autoapi#404 · 1 comment · Opened Sep 15, 2023
Support PEP-702 style deprecations Open

Difficulty 4/5 3-5 days Newbie friendliness 42/100

readthedocs/sphinx-autoapi#401 · 8 comments · 1 reaction · Opened Aug 29, 2023
Ambiguous type references when classes share the same name Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#395 · Opened Jun 13, 2023
A module attribute with a value declared separately from its type is documented twice Open

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

readthedocs/sphinx-autoapi#387 · Opened May 29, 2023
Configure a bug report template Open

Difficulty 2/5 1-3 hours Newbie friendliness 48/100

readthedocs/sphinx-autoapi#386 · Opened May 23, 2023
Write a contribution guide Open

Difficulty 3/5 1-2 days Newbie friendliness 42/100

readthedocs/sphinx-autoapi#385 · Opened May 23, 2023
Support of incremental builds? Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#380 · 1 comment · Opened Apr 21, 2023
`more than one target found for cross-reference` warning appeared after upgrading to `sphinx==5.2.3` and `sphinx-autoapi>=2.0.0` Open

Difficulty 4/5 3-5 days Newbie friendliness 30/100

readthedocs/sphinx-autoapi#357 · 1 comment · Opened Oct 28, 2022
Add header before module contents docs when showing summaries Open

Difficulty 4/5 3-5 days Newbie friendliness 38/100

readthedocs/sphinx-autoapi#351 · 2 reactions · Opened Sep 21, 2022
Add pound colon #: parsing Open

Language: Python

Difficulty 3/5 1-2 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#344 · 8 comments · 10 reactions · Opened Jul 29, 2022
`autoapimodule` directive in "manual mode": Imported members are documented Open

Language: Python

Difficulty 4/5 3-5 days Newbie friendliness 32/100

readthedocs/sphinx-autoapi#342 · 2 comments · Opened Jul 3, 2022
`duplicate object description` when redefing variable with `if` block Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#335 · 2 comments · 1 reaction · Opened Apr 27, 2022
Strange warning in autosummary when literal block notation is used in first line of docstring Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

readthedocs/sphinx-autoapi#327 · Opened Feb 15, 2022
Directive `.. autoapiclass` does not respect `autoapi_member_order = "bysource"` Open

Language: Python

Difficulty 3/5 1-2 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#325 · 2 reactions · Opened Feb 8, 2022
Excluding directories Open

Good First Issue

Difficulty 3/5 1-2 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#312 · 4 comments · 2 reactions · Opened Nov 11, 2021
Full name not resolved correctly for class not imported from real source Open

Language: Python Needed: Design Decision

Difficulty 4/5 3-5 days Newbie friendliness 45/100

readthedocs/sphinx-autoapi#310 · 2 comments · 1 reaction · Opened Oct 19, 2021
Module table of contents are poorly formatted when long type hints are present Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#305 · 2 comments · 3 reactions · Opened Sep 28, 2021
Python `module.rst` top-level section headers get eaten by Sphinx Open

Needed: Reproduction Case

Difficulty 4/5 3-5 days Newbie friendliness 35/100

readthedocs/sphinx-autoapi#302 · 3 comments · Opened Aug 23, 2021

readthedocs/sphinx-autoapi

Get new issues in your inbox