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
675 Commits 14 Branches 43 Tags 5 MiB
6028cb104c
Commit Graph

200 Commits

Author SHA1 Message Date
Ashley Whetter
6028cb104c Fail elegantly when no source files are found 
Fixes #324
 2022-02-08 21:44:16 -08:00
Ashley Whetter
948f753a20 Fixed compatibility with astroid 2.7+. 
Fixes #301
 2021-08-16 10:23:20 -07:00
Ashley Whetter
7d7f042805 Fixed possible incorrect indentation in generated documentation. 
Closes #299.
 2021-07-31 18:06:12 -07:00
Ashley Whetter
08e61b93ef Fixed displaying "self" in class signatures 2021-06-25 19:30:54 -07:00
Ashley Whetter
5faec73073 Fixed error when parsing a class with no constructor 2021-06-21 23:10:52 -07:00
Ashley Whetter
613eff53a7 Fixed type annotations being shown for only a single module 
Closes #273
 2021-04-24 19:43:39 -07:00
Ashley Whetter
86a6d1059c Refactored dotnet error to raise an exception properly 2021-04-12 20:32:37 -07:00
René Fritze
5777e43347 remove (sub-) types for "Unknown type" warnings 2021-04-12 19:58:00 -07:00
René Fritze
dbd1e9dfe6 Adds a subtype to all logger.warning calls 2021-04-12 19:58:00 -07:00
René Fritze
bec1f6c1b0 Adds a referenceable type to logging warnings 
This allows users to use the sphinx config `suppress_warnings =
['autoapi']` to ignore warnings emitted from autoapi.
 2021-04-12 19:58:00 -07:00
Ashley Whetter
66f3734afa Start testing in Github Actions 2021-04-04 20:23:24 -07:00
Ashley Whetter
826bb2badd Converted tests to pytest style 2021-04-03 19:01:27 -07:00
Ashley Whetter
a0591adae4 Represent overload typehints more accurately 2021-04-03 11:12:42 -07:00
Ashley Whetter
7541f922ae Fixed data annotations causing pickle or deepcopy errors 
Closes #261
 2021-04-02 20:57:06 -07:00
Ashley Whetter
bf8f50dc97 Fixed type hints still showing when setting autodoc_typehints 
Closes #273
 2021-04-02 20:08:34 -07:00
Ashley Whetter
7872ed00b0 Can link to parameters of generic base classes 2021-03-19 23:55:35 -07:00
Ashley Whetter
643fed0ccd Can resolve the qualified paths of parameters to generics 
Closes #265
 2021-03-19 23:11:52 -07:00
Ashley Whetter
471c870a53 Do not inherit redundant docstrings 
Closes #240
 2021-01-31 16:12:19 -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
a8d07b610f Can edit the Jinja environment 
Closes #200
 2020-11-13 22:47:32 -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
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
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
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
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
Ashley Whetter
28301f1ba4 Fix linting again 2019-10-05 17:00:05 -07:00
Ashley Whetter
520f3b0469 Fixed formatting 2019-10-05 16:09:26 -07:00
Ashley Whetter
a122f00d4a Fix linting 2019-10-05 16:05:37 -07:00