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
652 Commits 14 Branches 43 Tags 5 MiB
099e6e89c1
Commit Graph

153 Commits

Author SHA1 Message Date
Ashley Whetter
826bb2badd Converted tests to pytest style 2021-04-03 19:01:27 -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
643fed0ccd Can resolve the qualified paths of parameters to generics 
Closes #265
 2021-03-19 23:11:52 -07:00
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
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
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
Ash Berlin-Taylor
5ee7dbef59 Correctly parse Metaclasses 
Fixes #246
 2020-10-25 19:17:07 -07:00
Ashley Whetter
7330297a83 Fixed tests on Python <3.8 2020-10-07 22:46:58 -07:00
Ashley Whetter
8256daa090 Fixed test setup 2020-10-07 22:18:43 -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
9a5f22d7d6 One day I'll learn to run black before pushing... 2020-08-31 22:07:51 -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
7270718374 Add support for overloaded functions 2020-08-17 12:48:36 -07:00
Haggai Nuchi
d0de570660 Remove xfail designation 2020-08-14 22:09:28 -07:00
Ashley Whetter
ac70ea056e Fixed incorrect formatting of properties on generated method directives. 2020-07-31 23:28:53 -07:00
Ashley Whetter
6fa5cb941d Fixed tests 2020-07-12 16:02:30 -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
f5823855ba Added Sphinx 3.1 testing 2020-07-11 19:14:03 -07:00
Matthijs van der Burgh
827297433a don't find in class summary 2020-06-13 10:04:03 -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
Matthijs van der Burgh
8565616f98 Fix formatting of test_pyintegration.py 2020-05-16 14:09:22 -07:00
Ashley Whetter
2e875f81c3 Updated tests for latest Sphinx 3.0.x fixes 2020-05-14 20:32:24 -07:00
Ashley Whetter
5794902b23 Support Sphinx 2.4 and 3.0 2020-04-05 20:03:05 -07: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
3747596021 Fixed formatting 2020-01-11 14:52:37 -08:00
Ashley Whetter
fc1d78f758 Python 3.8 support 2020-01-11 14:37:13 -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
Olivier Samyn
5f085ca47f test: add implicit namespace checks 2020-01-03 08:39:06 -08: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
Daniel Daniels
a114af76dc Added autoapi-skip-member event 2019-10-05 13:55:18 -07:00
danields761
be324b10bf Made dependencies of other languages optional (#171) 
* Fixes #170

* Makes sphinxcontrib-golangdomain and
sphinxcontrib-dotnetdomain to be optional
packages
* Adds check that appropriate dependencies of
a specified api-type installed during the
extension initialisation
* Adds appropriate tests
 2019-09-01 14:44:17 -07:00
Ashley Whetter
02b0c0a098 Made it more clear which file causes an error 2019-08-25 17:04:30 -07:00
Ashley Whetter
86a2aeb6d7 Fixed some unicode decode errors 2019-08-25 15:53:58 -07:00
Ashley Whetter
fd1cef5ced Updated Autodoc directives for Sphinx 2.1 features 
Added autoapidecorator directive.
Abides by autodoc_docstring_signature.
autoapifunction documents async functions.

Closes #166.
 2019-08-10 23:08:03 -07:00
Ashley Whetter
34d02faa2f Custom argument formatting 
Closes #162
 2019-08-07 23:23:21 -07:00
Ashley Whetter
46c577eda1 Support for async and other Sphinx 2.1 method directive options 2019-07-17 20:59:20 -07:00