Commit Graph

660 Commits

Author SHA1 Message Date
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
4f46d3698b Fix and update pre-commit config 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
d0de570660 Remove xfail designation 2020-08-14 22:09:28 -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
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
Ashley Whetter
37a2ce3301 Fixed typo in the changelog 2020-06-18 13:45:42 -07:00
Matthijs van der Burgh
827297433a don't find in class summary 2020-06-13 10:04:03 -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
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
Ashley Whetter
8b9f0c23b5 Corrected autoapi_options default value 2020-05-16 18:00:04 -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
Matthijs van der Burgh
8565616f98 Fix formatting of test_pyintegration.py 2020-05-16 14:09:22 -07:00
Matthijs van der Burgh
7e79a1b9f7 (travis) fix warnings 2020-05-16 14:09:22 -07:00
Matthijs van der Burgh
8f91c14199 Show black diff 2020-05-16 14:09:22 -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
2e875f81c3 Updated tests for latest Sphinx 3.0.x fixes 2020-05-14 20:32:24 -07:00
Matthijs van der Burgh
0e7930e2e0 Fix version in docs conf.py 2020-05-14 20:00:25 -07:00
Matthijs van der Burgh
b8f1ba7cff Update release process with added version number 2020-05-14 20:00:25 -07:00
Matthijs van der Burgh
e0b41e00a7 Add __version__ to __init__.py 2020-05-14 20:00:25 -07:00
Ashley Whetter
3eb33270c5 Version 1.3.0 2020-04-05 20:26:00 -07:00
Ashley Whetter
6bfe168abe Updated Travis Python versions 2020-04-05 20:09:07 -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
9008db48e5 Added assertion to assist with import resolution debugging 2020-04-05 18:25:07 -07:00
Ashley Whetter
c3fe9f77cb Fixed minor changelog formatting issue 2020-02-01 13:04:31 -08: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