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
682 Commits 14 Branches 43 Tags 5 MiB
432b9af5d5
Commit Graph

397 Commits

Author SHA1 Message Date
Nathan Glenn
432b9af5d5
Fix keyerror when using markdown sources (#321) 
Setting `source_suffix = ".md"` led to the following cryptic error output:

    Handler <function run_autoapi at 0x10841fc10> for event 'builder-inited' threw an exception (exception: 0)

This issue was that `app.config.source_suffix` is an `OrderedDict` object, which cannot be subscripted
using `[0]`, etc. Instead, use `next(iter(...))` to get the first element of the dictionary.
 2022-07-25 11:32:11 -07:00
Zachary Moon
185876a047
Limit signatures to 60 characters in summaries (#311) 2022-07-25 10:30:57 -07:00
Mathieu Bouzard
fc6b8aec77
Fix comment typehints for methods/classmethods (#300) 
* Fix comment typehints for methods and classmethods

Co-authored-by: Mathieu <923463-mathbou@users.noreply.gitlab.com>
 2022-07-25 10:27:03 -07:00
Ashley Whetter
517a6be383 Stop calling `autodoc-process-docstring` when docstring is empty 2022-07-25 10:22:38 -07:00
Ashley Whetter
6028cb104c Fail elegantly when no source files are found 
Fixes #324
 2022-02-08 21:44:16 -08:00
Ashley Whetter
685d1d34c8 Updated to latest black formatting 2022-02-08 19:37:55 -08:00
Ashley Whetter
19d217e177 Version 1.8.4 2021-08-16 10:29:05 -07:00
Ashley Whetter
948f753a20 Fixed compatibility with astroid 2.7+. 
Fixes #301
 2021-08-16 10:23:20 -07:00
Ashley Whetter
4d8f6387ca Version 1.8.3 2021-07-31 18:27:38 -07:00
Ashley Whetter
38c2089476 Removed prepare_docstring filter used for testing 2021-07-31 18:25:25 -07:00
Ashley Whetter
7d7f042805 Fixed possible incorrect indentation in generated documentation. 
Closes #299.
 2021-07-31 18:06:12 -07:00
Ashley Whetter
354535190c Version 1.8.2 2021-07-26 18:10:22 -07:00
Ashley Whetter
2c5c87157a Explicitly use the domain for generated directives 
Closes #292
 2021-06-27 17:25:36 -07:00
Ashley Whetter
26b7d729a2 Fixed AttributeError using inheritance diagrams on a module with plain imports 
Fixes #289
 2021-06-27 16:54:36 -07:00
Ashley Whetter
17ffa2d1b6 Fixed failure to build out of source conf.py files 
Closes #293
 2021-06-25 20:14:33 -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
83b1260e67 Version 1.8.1 2021-04-24 19:49:49 -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
48ec2b341e Version 1.8.0 2021-04-12 20:46:07 -07:00
Sam Morley-Short
3fb14a24fc Added attribute summary table to python module template 2021-04-12 20:34:33 -07:00
Kamil Breguła
57253a9f84 Generate rst files in src directory 2021-04-12 20:33:33 -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
9372bdb9f1 Package with PEP-517 2021-04-03 18:39:08 -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
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
05dde9584c Version 1.7.0 2021-01-31 22:26:44 -08: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
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