Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-16 00:12:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
591 Commits 14 Branches 43 Tags 5 MiB
827297433a
Commit Graph

169 Commits

Author SHA1 Message Date
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
Daniel Daniels
a114af76dc Added autoapi-skip-member event 2019-10-05 13:55:18 -07:00
谷月轩
f6649ebde4 Include methods in child class (#176) 2019-10-05 12:39:50 -07:00
Armand BENETEAU
fa3b0b3f70 Fix Go documentation generation (#172) 
* Correction of the "parameters" accessibility problem in the Go mapper

The "parameters" attributes of the GoPythonMapper class instance was
not accessible from the "output_rst" function used to create the .rst
file. Thanks to this correction, the parameters are now accessible.

* Enhance the template used to genertae the .rst file from the .go source file

This modification allows to create a .rst file compatible with the
last version of Sphinx. Without this correction, the creation of documentation
was not possible. A "make html" command lead to an "AssertionError" Exception.
 2019-09-03 20:55:52 -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
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
Ashley Whetter
589826e90c Can override ignoring local imports in modules by using __all__ 2019-06-23 12:36:58 -07:00
Ashley Whetter
b90284f0fe Support basic type annotations 
Closes #139
 2019-04-21 21:58:25 -07:00
Ashley Whetter
b5dfea1c6d Removed some dead code 2019-04-21 15:40:00 -07:00
Ashley Whetter
7230330686 Documentation overhaul 2019-04-21 15:38:22 -07:00
Ashley Whetter
dd58809d89 Added support for parsing stub files 
Closes #100
 2019-04-06 11:25:39 -07:00
Ashley Whetter
3b299be332 Tidied up index page 2019-04-06 10:33:38 -07:00
Ashley Whetter
c6b46969f8 Fixed decoding of binary data on Python 2 
Fixes #159
 2019-03-30 13:43:26 -07:00
Ashley Whetter
a4f798183c Fixed private submodules displaying when private-members turned off 
Also fixed whitespace issues in templates.
 2019-03-05 22:52:13 -08:00
Alexander Gor
b94acc6019 Properly pass file patterns to godocjson utility (#161) 
* Properly pass  file patterns to godocjson utility

* Go integration tests fixed during to new *ignore* argument
 2019-02-20 07:26:20 -08:00
Ashley Whetter
80fd76bd1e Fixed false warning when importing a local module 2019-02-04 21:21:32 -08:00
Ashley Whetter
68e1f79ed5 Added render log messages 2019-01-30 21:53:08 -08:00
Ashley Whetter
f77bf19800 Added Black formatting 2019-01-26 21:20:45 -08:00
Ashley Whetter
2cf80b1569 Fixed Sphinx logger deprecation warnings 2019-01-26 17:11:12 -08:00
Ashley Whetter
dfe82ae94e Dropped support for Sphinx<1.6 2019-01-26 16:26:39 -08:00
Ashley Whetter
00894a959e Overhauled Python import resolution logic 
Stable in more complex cases.
Capable of giving more detailed warnings.
More closely matches real import logic.

Closes #156
 2019-01-26 16:18:16 -08:00
Ashley Whetter
1caa6d22e1 Fixed some import chains failing to resolve depending on resolution order 2018-11-15 13:31:33 -08:00
Ashley Whetter
3b52975340 Fixed unicode decoding on Python 3.7 2018-11-14 22:40:22 -08:00
Ashley Whetter
aac53178eb Fixed error parsing files with unicode docstrings 2018-11-13 11:07:36 -08:00
Ashley Whetter
a1f1fd8651 Fixed properly resolving definitions imported more than once 2018-09-07 17:36:20 -07:00
Ashley Whetter
2799fb32cc Fixed error when documenting something that's imported in more than one place 2018-09-07 16:56:11 -07:00
Ashley Whetter
007ef746f4 Fixed linter again 2018-08-20 11:01:07 -07:00
Ashley Whetter
fb8892ccad Fixed lint error 2018-08-20 09:48:24 -07:00
Ashley Whetter
c3f3cc33de Added viewcode support for imported members 2018-08-20 09:37:43 -07:00
Ashley Whetter
92b4ea9dc8 Fixed linking to builtin bases 2018-08-13 17:26:54 -07:00