Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-10 01:10:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
629 Commits 14 Branches 43 Tags 5 MiB
731323c2a4
Commit Graph

357 Commits

Author SHA1 Message Date
Ashley Whetter
731323c2a4 Version 1.6.0 2021-01-20 15:13:20 -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
Ash Berlin-Taylor
5ee7dbef59 Correctly parse Metaclasses 
Fixes #246
 2020-10-25 19:17:07 -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
Brent Yi
f986f02105 Fix inheritance diagram from module 2020-09-08 18:05:02 -07:00
Ashley Whetter
0667de4037 Release preparation 2020-08-31 21:59:16 -07:00
Ashley Whetter
fc634afc0d Fix formatting after black upgrade 2020-08-31 21:24:27 -07:00
Ashley Whetter
0a5b84b8be autoapi_file_patterns is in order of preference 
Closes #243
 2020-08-31 21:18:36 -07:00
Taku Fukada
5bb4ff2c02 Refine overload support 2020-08-17 12:48:36 -07:00
Taku Fukada
8f4a4b1f0c Refactor the child function/method parsing loop 2020-08-17 12:48:36 -07:00
Taku Fukada
78db701450 Ignore some pylint checks 2020-08-17 12:48:36 -07:00
Taku Fukada
7270718374 Add support for overloaded functions 2020-08-17 12:48:36 -07:00
Haggai Nuchi
a58b7ed45b Update documenters.py 2020-08-14 22:09:28 -07:00
Taku Fukada
3b35293f9c Make NestedParse not to wrap their content with a paragraph 2020-08-02 10:12:49 -07:00
Taku Fukada
b2b5f62847 Fix #234: Inject TOCs just after doctrees are read 2020-08-02 09:43:45 -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
Thorsten Beier
d08522c525
Added default golang ingore pattern to remove unit tests by default (#231) 2020-07-22 20:50:48 -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
9bd08a2bc1 Version 1.4.0 2020-06-07 19:15:13 -07:00
lhfriedman
c51fb3f737 added scoped keywords 
see issue 213 (https://github.com/readthedocs/sphinx-autoapi/issues/213)
 2020-06-07 18:57:26 -07:00
Ashley Whetter
975ac49dc0 Inheritance diagrams can follow imports 
Closes #193
Closes #208
 2020-06-07 18:47:34 -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
2f87d5ef82 Added __version_info__ and single source version 2020-05-14 20:37:18 -07:00
Matthijs van der Burgh
e0b41e00a7 Add __version__ to __init__.py 2020-05-14 20:00:25 -07:00
Ashley Whetter
0d95377bbf Accept template directory relative to conf.py 
Closes #184
 2020-04-05 18:50:32 -07:00
Ashley Whetter
9008db48e5 Added assertion to assist with import resolution debugging 2020-04-05 18:25:07 -07:00
Ashley Whetter
428e8526f0 Fixed Python 2 support 2020-02-01 12:53:40 -08:00
Ashley Whetter
4ba45cfacb Can document inherited members 
Closes #183
 2020-02-01 12:53:40 -08:00
Ashley Whetter
c5d5fb5346 Made passing of options to templates more sane 2020-01-25 17:36:06 -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
b5b2b2f08e Make the linter happy again 2020-01-03 09:26:32 -08:00
Olivier Samyn
d71ac5f250 fix: Make the linter happy 2020-01-03 08:39:06 -08:00
Olivier Samyn
cca3a781ee fix: correct stop condition in sphinx <2.0 and add a stop guard. 2020-01-03 08:39:06 -08:00
Olivier Samyn 🎻
7ca958fe57 feat: Support implicit namespaces for python >= 3.3 2020-01-03 08:39:06 -08:00