Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-10-31 21:20:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
761 Commits 14 Branches 43 Tags 5 MiB
3b037c7643
Commit Graph

144 Commits

Author SHA1 Message Date
Ashley Whetter
3b037c7643 Moved bugfix announcement into a separate news item 
Closes #224
 2024-04-01 22:29:52 -07:00
Ashley Whetter
bc71226c3b Render PEP-695 type aliases as TypeAlias assignments 
Partially addresses #414
 2024-04-01 22:24:36 -07:00
Ashley Whetter
007077a7db Refactor mapper classes into their bases 
This separate used to exist to support parsing multiple languages,
which we no longer do.
 2024-03-25 21:14:35 -07:00
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.
 2024-03-25 19:49:37 -07:00
Ashley Whetter
93fb571a7e Basic tests for single page rendering 2024-03-25 19:46:23 -07:00
Jorge Martinez Garrido
ecd47ea456 Initial implementation of customisable single page output 2024-03-25 19:46:23 -07:00
George Zhang
0d69974c19 Preserve strings inside Literal type annotations 2024-03-25 19:30:27 -07:00
Ashley Whetter
c4db7eb14a Fix IndexError when a module docstring contains only a heading 2024-02-18 21:17:06 -08:00
Ashley Whetter
422004ea91 Made links in the README less confusing 2024-02-18 16:28:37 -08:00
laggykiller
823c146b3a Correct handling of __init__.pyi 
Closes #405
 2024-02-18 16:01:48 -08:00
Ashley Whetter
bbb50f68ae Reformatted to latest stable black style 2024-02-18 15:57:31 -08:00
Ashley Whetter
61c52e0664 Implemented automatic uploading to PyPI 
Closes #388
 2023-09-30 10:54:18 -07:00
Ashley Whetter
006142dbad Version 3.0.0 2023-09-26 12:53:19 -07:00
Brandon Wiebe
6317148f0d Replace usage of deprecated astroid.NodeNG.doc in inheritance_diagrams.py 2023-09-26 12:50:57 -07:00
Ashley Whetter
4d1bec044a Removed support for Python 3.7 2023-09-24 08:57:47 -07:00
Ashley Whetter
92437c9af7 Removed old pylint pragmas 2023-07-08 10:38:24 -07:00
Ashley Whetter
a22ae9262a Removed support for documenting languages other than Python 
For the reasons why, see #248
 2023-07-08 10:35:38 -07:00
Ken Odegard
7b90b43f94 Add news 2023-07-08 10:01:55 -07:00
Ashley Whetter
0ba883ab89 Replace usage of deprecated astroid.NodeNG.doc 
Closes #392
 2023-07-06 21:14:32 -07:00
Ashley Whetter
6f4e12a00c Start testing on Python 3.12 
Closes #390
 2023-07-06 19:57:58 -07:00
Ashley Whetter
1e6b1fa4c4 Build docs in Python 3.11 on readthedocs 
Closes #389
 2023-07-06 19:51:26 -07:00
Ashley Whetter
0ac1e11359 Version 2.1.1 2023-06-10 10:58:13 -07:00
Ashley Whetter
c3c6e15d16 Added missing changelog entry 2023-06-10 10:36:30 -07:00
Ashley Whetter
38a615ff74 Types used in PEP-604 union syntax can be linked with intersphinx 
Closes #366
 2023-06-10 10:07:20 -07:00
Ashley Whetter
7fa3998438 Fix separated type comments for arguments not merging correctly in Python 3.7 2023-05-30 20:33:59 -07:00
Ashley Whetter
434ef8305a Tests build HTML and parse it to validate structure 2023-05-30 18:59:20 -07:00
Ashley Whetter
1ae7b78128 Fix class overrides not rendering correctly 2023-05-22 19:58:40 -07:00
Ashley Whetter
0a557fc95e Replaced usage of unidecode with anyascii to fix license incompatibilities 
Closes #382
 2023-05-22 10:10:05 -07:00
Ashley Whetter
aab9f814b8 Made it clearer how to customise what objects AutoAPI will document. 
Closes #339
 2023-05-22 09:38:24 -07:00
Ashley Whetter
9c774d4242 Overhauled documentation landing page 2023-04-30 09:51:52 -07:00
Ashley Whetter
12f8197cfe Added a basic dev container 2023-04-29 21:21:22 -07:00
Ashley Whetter
1715dfe0b5 Fix "document isn't included" warning when using autoapi_add_toctree_entry 
Closes #319
 2023-04-10 16:49:21 -07:00
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>
 2023-04-07 10:30:46 -07:00
Ashley Whetter
85739d513e Switched to Google style docstrings 2023-03-29 17:44:57 -07:00
Ashley Whetter
a43c6fde2b Switched linter from pylint to ruff 2023-03-29 17:30:21 -07:00
Ashley Whetter
47e5dcd707 Version 2.1.0 2023-03-28 09:45:29 -07:00
Ashley Whetter
5fa927c682 Document the deprecation for other languages 2023-03-28 09:25:41 -07:00
Ashley Whetter
f44080391b Adjusted documentation around toctree editing 2023-03-28 09:17:05 -07:00
Brandon Wiebe
6b16e02de4
Let Sphinx handle adding domain directives to the toctree (#374) 
* Remove ability to add domains to the toctree

* Add towncrier news fragment
 2023-03-28 09:13:28 -07:00
Ashley Whetter
58d653e557 Added basic type checking 2023-03-22 22:33:11 -07:00
Ashley Whetter
1401facbc0 Integrated towncrier into the release workflow 2023-03-22 21:50:01 -07:00
Jakob Lykke Andersen
377a38550f
Add option autoapi_add_objects_to_toctree (#284) 2022-10-23 14:16:42 -07:00
Ashley Whetter
a23e2ffe73 Render Python properties with the property directive 
Fixes #352.
 2022-09-27 15:57:44 -07:00
Bruno P. Kinoshita
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
 2022-09-27 12:18:48 -07:00
Ashley Whetter
991ac220fd Streamlined release process slightly 2022-07-25 12:00:54 -07:00
Kian-Meng Ang
075736619f
Fix typos (#331) 2022-07-25 11:34:17 -07:00
Ashley Whetter
cd4e1fa59f Fixed tests in Sphinx 5 2022-07-25 10:20:51 -07:00
Ashley Whetter
7cdc0dfae3 Fixed broken link to Jinja objects.inv 2021-07-31 18:25:33 -07:00
Ashley Whetter
17ffa2d1b6 Fixed failure to build out of source conf.py files 
Closes #293
 2021-06-25 20:14:33 -07:00
Ashley Whetter
48ec2b341e Version 1.8.0 2021-04-12 20:46:07 -07:00