f23b079e7d
Stop using xrefs in page titles
...
Closes #427
2 months ago
3b037c7643
Moved bugfix announcement into a separate news item
...
Closes #224
2 months ago
bc71226c3b
Render PEP-695 type aliases as TypeAlias assignments
...
Partially addresses #414
2 months ago
007077a7db
Refactor mapper classes into their bases
...
This separate used to exist to support parsing multiple languages,
which we no longer do.
2 months ago
a6558dcfc2
Various fixes for own page output
...
Also added tests for own page output.
Fix some inherited members always being rendered.
Own page members of an entity are linked to after the docstring
of the parent entity.
Fix entities below the "class" level that have their own page
from rendering incorrectly.
Rename "single page output" to "own page output". An entity does
not have a "single page" when its members are spread across
their own pages.
Properties are linked to on their parent classes page.
Children not present in `__all__` are not rendered.
Fixed emitting ignore event twice for methods.
Corrected documentation around `imported-members` to reflect that it
applies only to objects imported into a package, not modules.
Fixed path error on Windows.
2 months ago
93fb571a7e
Basic tests for single page rendering
2 months ago
ecd47ea456
Initial implementation of customisable single page output
2 months ago
0d69974c19
Preserve strings inside Literal type annotations
2 months ago
c4db7eb14a
Fix IndexError when a module docstring contains only a heading
3 months ago
422004ea91
Made links in the README less confusing
3 months ago
823c146b3a
Correct handling of `__init__.pyi`
...
Closes #405
3 months ago
bbb50f68ae
Reformatted to latest stable black style
3 months ago
61c52e0664
Implemented automatic uploading to PyPI
...
Closes #388
8 months ago
006142dbad
Version 3.0.0
8 months ago
6317148f0d
Replace usage of deprecated astroid.NodeNG.doc in inheritance_diagrams.py
8 months ago
4d1bec044a
Removed support for Python 3.7
8 months ago
92437c9af7
Removed old pylint pragmas
11 months ago
a22ae9262a
Removed support for documenting languages other than Python
...
For the reasons why, see #248
11 months ago
7b90b43f94
Add news
11 months ago
0ba883ab89
Replace usage of deprecated astroid.NodeNG.doc
...
Closes #392
11 months ago
6f4e12a00c
Start testing on Python 3.12
...
Closes #390
11 months ago
1e6b1fa4c4
Build docs in Python 3.11 on readthedocs
...
Closes #389
11 months ago
0ac1e11359
Version 2.1.1
12 months ago
c3c6e15d16
Added missing changelog entry
12 months ago
38a615ff74
Types used in PEP-604 union syntax can be linked with intersphinx
...
Closes #366
12 months ago
7fa3998438
Fix separated type comments for arguments not merging correctly in Python 3.7
1 year ago
434ef8305a
Tests build HTML and parse it to validate structure
1 year ago
1ae7b78128
Fix class overrides not rendering correctly
1 year ago
0a557fc95e
Replaced usage of unidecode with anyascii to fix license incompatibilities
...
Closes #382
1 year ago
aab9f814b8
Made it clearer how to customise what objects AutoAPI will document.
...
Closes #339
1 year ago
9c774d4242
Overhauled documentation landing page
1 year ago
12f8197cfe
Added a basic dev container
1 year ago
1715dfe0b5
Fix "document isn't included" warning when using autoapi_add_toctree_entry
...
Closes #319
1 year ago
0ec649a555
Remove redundant wheel dep from pyproject.toml ( #375 )
...
Remove the redundant `wheel` dependency, as it is added by the backend
automatically. Listing it explicitly in the documentation was
a historical mistake and has been fixed since, see:
f7d30a9529
1 year ago
85739d513e
Switched to Google style docstrings
1 year ago
a43c6fde2b
Switched linter from pylint to ruff
1 year ago
47e5dcd707
Version 2.1.0
1 year ago
5fa927c682
Document the deprecation for other languages
1 year ago
f44080391b
Adjusted documentation around toctree editing
1 year ago
6b16e02de4
Let Sphinx handle adding domain directives to the toctree ( #374 )
...
* Remove ability to add domains to the toctree
* Add towncrier news fragment
1 year ago
58d653e557
Added basic type checking
1 year ago
1401facbc0
Integrated towncrier into the release workflow
1 year ago
377a38550f
Add option autoapi_add_objects_to_toctree ( #284 )
2 years ago
a23e2ffe73
Render Python properties with the property directive
...
Fixes #352 .
2 years ago
c9edd8d1c6
Minor fixes (typos, http->https in links, types) ( #348 )
...
* Avoid http->https redirect, use https where possible
* Add autoapi_template_dir to existing array instead of re-declaring
* Typos
* Sphinx util uses int for verbosity in status_iterator
* Sphinx utils uses tuples for TypeField arguments
2 years ago
991ac220fd
Streamlined release process slightly
2 years ago
075736619f
Fix typos ( #331 )
2 years ago
cd4e1fa59f
Fixed tests in Sphinx 5
2 years ago
7cdc0dfae3
Fixed broken link to Jinja objects.inv
3 years ago
17ffa2d1b6
Fixed failure to build out of source conf.py files
...
Closes #293
3 years ago
Ashley Whetter
Jorge Martinez Garrido
George Zhang
laggykiller
Brandon Wiebe
Ken Odegard
Michał Górny
Jakob Lykke Andersen
Bruno P. Kinoshita
Kian-Meng Ang