Ashley Whetter
53de7fd42d
Version 3.1.0b0
5 months ago
Ashley Whetter
f23b079e7d
Stop using xrefs in page titles
...
Closes #427
5 months ago
Ashley Whetter
3b037c7643
Moved bugfix announcement into a separate news item
...
Closes #224
6 months ago
Ashley Whetter
bc71226c3b
Render PEP-695 type aliases as TypeAlias assignments
...
Partially addresses #414
6 months ago
Ashley Whetter
007077a7db
Refactor mapper classes into their bases
...
This separate used to exist to support parsing multiple languages,
which we no longer do.
6 months ago
Ashley Whetter
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.
6 months ago
Jorge Martinez
2a603b8ac0
Recursive rendering of children with their own page
6 months ago
Ashley Whetter
93fb571a7e
Basic tests for single page rendering
6 months ago
Jorge Martinez Garrido
ecd47ea456
Initial implementation of customisable single page output
6 months ago
George Zhang
0d69974c19
Preserve strings inside Literal type annotations
6 months ago
George Zhang
34a96700ea
Replace usage of deprecated docutils.nodes.Node.traverse
6 months ago
Ashley Whetter
bea6e14a89
Fix deprecation warning from ruff
6 months ago
Ashley Whetter
67c0b5f821
Fix type checking against latest Sphinx
6 months ago
Ashley Whetter
c4db7eb14a
Fix IndexError when a module docstring contains only a heading
7 months ago
Ashley Whetter
422004ea91
Made links in the README less confusing
7 months ago
laggykiller
823c146b3a
Correct handling of `__init__.pyi`
...
Closes #405
7 months ago
Ashley Whetter
bbb50f68ae
Reformatted to latest stable black style
7 months ago
Ashley Whetter
61c52e0664
Implemented automatic uploading to PyPI
...
Closes #388
12 months ago
Ashley Whetter
006142dbad
Version 3.0.0
1 year ago
Brandon Wiebe
6317148f0d
Replace usage of deprecated astroid.NodeNG.doc in inheritance_diagrams.py
1 year ago
Ashley Whetter
4d1bec044a
Removed support for Python 3.7
1 year ago
Niels Wouda
cf8abe579f
Import fallback for older versions of Sphinx
1 year ago
Niels Wouda
0186a3c978
Replace usage of deprecated sphinx.util.status_iterator
1 year ago
Ashley Whetter
92437c9af7
Removed old pylint pragmas
1 year ago
Ashley Whetter
a22ae9262a
Removed support for documenting languages other than Python
...
For the reasons why, see #248
1 year ago
Ken Odegard
7b90b43f94
Add news
1 year ago
Ken Odegard
4ea04f241e
Ensure tooltip is always a str
1 year ago
Ashley Whetter
9d970a6a66
Rename master to main
1 year ago
Ashley Whetter
2219dcdd7a
Fix compatibility with astroid v3
1 year ago
Ashley Whetter
0ba883ab89
Replace usage of deprecated astroid.NodeNG.doc
...
Closes #392
1 year ago
Ashley Whetter
6f4e12a00c
Start testing on Python 3.12
...
Closes #390
1 year ago
Ashley Whetter
1e6b1fa4c4
Build docs in Python 3.11 on readthedocs
...
Closes #389
1 year ago
Ashley Whetter
0ac1e11359
Version 2.1.1
1 year ago
Ashley Whetter
c3c6e15d16
Added missing changelog entry
1 year ago
Z-Fran
86cf7e2b87
Fix getting 'orig_path' for 'viewcode_follow_imported'
1 year ago
Ashley Whetter
38a615ff74
Types used in PEP-604 union syntax can be linked with intersphinx
...
Closes #366
1 year ago
Ashley Whetter
7fa3998438
Fix separated type comments for arguments not merging correctly in Python 3.7
1 year ago
Ashley Whetter
434ef8305a
Tests build HTML and parse it to validate structure
1 year ago
Ashley Whetter
1ae7b78128
Fix class overrides not rendering correctly
1 year ago
Ashley Whetter
0a557fc95e
Replaced usage of unidecode with anyascii to fix license incompatibilities
...
Closes #382
1 year ago
Ashley Whetter
aab9f814b8
Made it clearer how to customise what objects AutoAPI will document.
...
Closes #339
1 year ago
Ashley Whetter
9c774d4242
Overhauled documentation landing page
1 year ago
Ashley Whetter
12f8197cfe
Added a basic dev container
1 year ago
Ashley Whetter
1715dfe0b5
Fix "document isn't included" warning when using autoapi_add_toctree_entry
...
Closes #319
1 year ago
Ashley Whetter
8ffcd0fd67
Corrected formatting
1 year ago
Marco Sirabella
b4687e6ddc
Fix conditional depending on sphinx version
1 year ago
Michał Górny
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
---------
Co-authored-by: Ashley Whetter <ashley@awhetter.co.uk>
1 year ago
Ashley Whetter
336f52e2e9
Added missing deprecation warning for other language support
1 year ago
Ashley Whetter
85739d513e
Switched to Google style docstrings
2 years ago
Ashley Whetter
a43c6fde2b
Switched linter from pylint to ruff
2 years ago