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
636 Commits 14 Branches 43 Tags 5 MiB
5435536988
Commit Graph

58 Commits

Author SHA1 Message Date
Joseph Yu
5435536988 Multiline string are displayed correctly 2021-03-19 22:03:04 -07:00
Joseph Yu
b9a6fcd350 Minor internal test warnings fixes 2021-03-19 21:56:04 -07:00
Ashley Whetter
05dde9584c Version 1.7.0 2021-01-31 22:26:44 -08:00
Ashley Whetter
471c870a53 Do not inherit redundant docstrings 
Closes #240
 2021-01-31 16:12:19 -08:00
Ashley Whetter
24109875e1 The overload signatures of __init__ methods are documented 
Fixes #260
 2021-01-31 15:34:40 -08:00
Ashley Whetter
73bb2d6105 The fully qualified path of objects are included type annotations 2021-01-31 10:14:52 -08:00
Ashley Whetter
82eb508fe0 Added support for Sphinx 3.3 and 3.4 2021-01-31 10:12:42 -08:00
Ashley Whetter
731323c2a4 Version 1.6.0 2021-01-20 15:13:20 -08:00
Ashley Whetter
714c0609ba Added Python 3.9 support 2021-01-20 14:59:15 -08:00
Ashley Whetter
a8d07b610f Can edit the Jinja environment 
Closes #200
 2020-11-13 22:47:32 -08:00
Ashley Whetter
06a1969d11 Fixed autodoc directives documenting properties as methods 2020-11-13 21:28:47 -08:00
Ashley Whetter
e281137654 Fixed raising unnecessary deprecation warning 
Closes #244
 2020-10-26 16:22:26 -07:00
Ashley Whetter
78b79583af Implmented basic incremental building 
Closes #191
 2020-10-26 16:13:38 -07:00
Ashley Whetter
6a6f7a9f17 Added CHANGELOG entry 2020-10-26 16:13:38 -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
8e4cd49e1a Dropped support for Python 2 and Sphinx 1.x/2.x. 
Removed all old compatibility code.
 2020-10-03 12:21:25 -07:00
Ashley Whetter
40ebbc965f Version 1.5.1 2020-10-02 22:03:06 -07:00
Ashley Whetter
0667de4037 Release preparation 2020-08-31 21:59:16 -07:00
Ashley Whetter
8640355f3d autoapisummary directive inherits from autosummary for future stability 2020-08-01 01:25:09 -07:00
Ashley Whetter
8d841664ed Fixed every toctree entry getting added as a new list 2020-07-31 23:28:53 -07:00
Ashley Whetter
ac70ea056e Fixed incorrect formatting of properties on generated method directives. 2020-07-31 23:28:53 -07:00
Ashley Whetter
f5182a2291 Declare the extension as parallel safe 
Closes #222
 2020-07-11 19:53:00 -07:00
Ashley Whetter
3faa27053b Fixed return types not showing for methods. 
Fixes #219
 2020-07-11 19:27:59 -07:00
Ashley Whetter
37a2ce3301 Fixed typo in the changelog 2020-06-18 13:45:42 -07:00
Ashley Whetter
9bd08a2bc1 Version 1.4.0 2020-06-07 19:15:13 -07:00
Ashley Whetter
975ac49dc0 Inheritance diagrams can follow imports 
Closes #193
Closes #208
 2020-06-07 18:47:34 -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
ea150af1da Fixed incorrect formatting with private inheritance diagrams 
Fixes #195
 2020-05-16 17:51:09 -07:00
Ashley Whetter
cd9b9ca0fe Added the imported-members AutoAPI option 
Closes #204
 2020-05-16 17:36:52 -07:00
Ashley Whetter
fca36aa664 Classes and methods inherit docstrings from their parent 
Closes #203
 2020-05-16 16:24:16 -07:00
Ashley Whetter
b52378fa51 Added autoapi_member_order option 
Closes #201
 2020-05-16 15:28:43 -07:00
Ashley Whetter
e8326cb909 Make template override docs more clear 
Closes #198
 2020-05-14 20:40:43 -07:00
Ashley Whetter
2f87d5ef82 Added __version_info__ and single source version 2020-05-14 20:37:18 -07:00
Ashley Whetter
3eb33270c5 Version 1.3.0 2020-04-05 20:26:00 -07:00
Ashley Whetter
5794902b23 Support Sphinx 2.4 and 3.0 2020-04-05 20:03:05 -07:00
Ashley Whetter
3c4f0b7fe6 Tests are included in the sdist 2020-04-05 20:00:18 -07:00
Ashley Whetter
0d95377bbf Accept template directory relative to conf.py 
Closes #184
 2020-04-05 18:50:32 -07:00
Ashley Whetter
c3fe9f77cb Fixed minor changelog formatting issue 2020-02-01 13:04:31 -08:00
Ashley Whetter
4ba45cfacb Can document inherited members 
Closes #183
 2020-02-01 12:53:40 -08:00
Ashley Whetter
265b4ae562 Added show-inheritance 
Also turned autoapi_include_inheritance_graphs into a
show-inheritance-diagram AutoAPI option to be more consistent
with show-inheritance.

Partially implements #183
 2020-01-25 14:38:22 -08:00
Ashley Whetter
076427e6ae Added inheritance diagrams support 
Close #140
 2020-01-11 17:29:36 -08:00
Ashley Whetter
fc1d78f758 Python 3.8 support 2020-01-11 14:37:13 -08:00
Ashley Whetter
f8b6a6151c arg and kwargs annotations can be read from the function type comment 2020-01-08 10:23:34 -08:00
Ashley Whetter
9c91de9370 Ignore extra argument type annotations 
Closes #186
 2020-01-07 16:23:12 -08:00
Ashley Whetter
d40122948b Remaining rtfd -> readthedocs replacements 2020-01-03 12:12:04 -08:00
Ashley Whetter
4bccd1bfe7 Documentation tweaks 2020-01-03 09:22:57 -08:00
Ashley Whetter
daa5ce24a5 Version 1.2.1 2019-10-09 20:02:29 -07:00
Ashley Whetter
74889a9d07 "Invalid desc node" warning no longer raised for autodoc-style directives 2019-10-09 19:53:26 -07:00
Ashley Whetter
e06fa71dbc Version 1.2.0 2019-10-05 17:01:36 -07:00
Ashley Whetter
b8fddf9c0b Added some missing documentation 2019-10-05 16:05:37 -07:00