Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-11 19:10:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
738 Commits 14 Branches 43 Tags 5 MiB
7b90b43f94
Commit Graph

127 Commits

Author SHA1 Message Date
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
Ashley Whetter
86a6d1059c Refactored dotnet error to raise an exception properly 2021-04-12 20:32:37 -07:00
René Fritze
099e6e89c1 Add descriptions for logging warning subtypes 2021-04-12 19:58:00 -07:00
René Fritze
5777e43347 remove (sub-) types for "Unknown type" warnings 2021-04-12 19:58:00 -07:00
René Fritze
5035ea9e4a Document the warnings suppression options 2021-04-12 19:58:00 -07:00
Ashley Whetter
9372bdb9f1 Package with PEP-517 2021-04-03 18:39:08 -07:00
Ashley Whetter
a0591adae4 Represent overload typehints more accurately 2021-04-03 11:12:42 -07:00
Ashley Whetter
bf8f50dc97 Fixed type hints still showing when setting autodoc_typehints 
Closes #273
 2021-04-02 20:08:34 -07:00
Joseph Yu
aeecc3e3e4 Added autoapi-skip-member example 2021-03-19 22:09:14 -07:00
Ashley Whetter
471c870a53 Do not inherit redundant docstrings 
Closes #240
 2021-01-31 16:12:19 -08:00
Ashley Whetter
a8d07b610f Can edit the Jinja environment 
Closes #200
 2020-11-13 22:47:32 -08:00
Ashley Whetter
78b79583af Implmented basic incremental building 
Closes #191
 2020-10-26 16:13:38 -07:00
Ashley Whetter
bab6d1a726 Added git tagging to the release steps 2020-10-07 22:11:26 -07:00
Ashley Whetter
6f0299356a Can use type hints as parameter types and return types 2020-10-05 13:18:35 -07:00
Ashley Whetter
0a5b84b8be autoapi_file_patterns is in order of preference 
Closes #243
 2020-08-31 21:18:36 -07:00
Ashley Whetter
9bd08a2bc1 Version 1.4.0 2020-06-07 19:15:13 -07:00
Ashley Whetter
efe815c1df Fixed a typo in the code of the golang tutorial 
Closes #207
 2020-05-20 19:35:54 -07:00
Ashley Whetter
da8a0d8609 Made the behaviour of autoapi_dirs more clear 2020-05-16 18:38:32 -07:00