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.
2 years ago
Ashley Whetter
0e4f121a5d
Added missing changelog entries
2 years ago
Zachary Moon
185876a047
Limit signatures to 60 characters in summaries ( #311 )
2 years ago
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>
2 years ago
Ashley Whetter
517a6be383
Stop calling ``autodoc-process-docstring`` when docstring is empty
2 years ago
Ashley Whetter
cd4e1fa59f
Fixed tests in Sphinx 5
2 years ago
Ashley Whetter
17ad4b988e
Added new changelog entry
3 years ago
Ashley Whetter
6028cb104c
Fail elegantly when no source files are found
...
Fixes #324
3 years ago
Ashley Whetter
685d1d34c8
Updated to latest black formatting
3 years ago
Ashley Whetter
71c6ceebe0
Fixed Python 3.10 erroring on Github
3 years ago
Ashley Whetter
0b214b2ffd
Drop Python 3.6 and test in Python 3.10
3 years ago
Ashley Whetter
19d217e177
Version 1.8.4
3 years ago
Ashley Whetter
948f753a20
Fixed compatibility with astroid 2.7+.
...
Fixes #301
3 years ago
Ashley Whetter
4d8f6387ca
Version 1.8.3
3 years ago
Ashley Whetter
7cdc0dfae3
Fixed broken link to Jinja objects.inv
3 years ago
Ashley Whetter
38c2089476
Removed prepare_docstring filter used for testing
3 years ago
Ashley Whetter
7d7f042805
Fixed possible incorrect indentation in generated documentation.
...
Closes #299 .
3 years ago
Ashley Whetter
354535190c
Version 1.8.2
3 years ago
Ashley Whetter
2c5c87157a
Explicitly use the domain for generated directives
...
Closes #292
3 years ago
Ashley Whetter
26b7d729a2
Fixed AttributeError using inheritance diagrams on a module with plain imports
...
Fixes #289
3 years ago
Ashley Whetter
17ffa2d1b6
Fixed failure to build out of source conf.py files
...
Closes #293
3 years ago
Ashley Whetter
08e61b93ef
Fixed displaying "self" in class signatures
3 years ago
Ashley Whetter
5faec73073
Fixed error when parsing a class with no constructor
3 years ago
Ashley Whetter
83b1260e67
Version 1.8.1
3 years ago
Ashley Whetter
613eff53a7
Fixed type annotations being shown for only a single module
...
Closes #273
3 years ago
Ashley Whetter
48ec2b341e
Version 1.8.0
4 years ago
Ashley Whetter
dafd0cc89c
Added missing changelog entries
4 years ago
Sam Morley-Short
3fb14a24fc
Added attribute summary table to python module template
4 years ago
Kamil Breguła
57253a9f84
Generate rst files in src directory
4 years ago
Ashley Whetter
86a6d1059c
Refactored dotnet error to raise an exception properly
4 years ago
René Fritze
099e6e89c1
Add descriptions for logging warning subtypes
4 years ago
René Fritze
5777e43347
remove (sub-) types for "Unknown type" warnings
4 years ago
René Fritze
5035ea9e4a
Document the warnings suppression options
4 years ago
René Fritze
dbd1e9dfe6
Adds a subtype to all `logger.warning` calls
4 years ago
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.
4 years ago
Ashley Whetter
66f3734afa
Start testing in Github Actions
4 years ago
Ashley Whetter
826bb2badd
Converted tests to pytest style
4 years ago
Ashley Whetter
9372bdb9f1
Package with PEP-517
4 years ago
Ashley Whetter
a0591adae4
Represent overload typehints more accurately
4 years ago
Ashley Whetter
7541f922ae
Fixed data annotations causing pickle or deepcopy errors
...
Closes #261
4 years ago
Ashley Whetter
bf8f50dc97
Fixed type hints still showing when setting autodoc_typehints
...
Closes #273
4 years ago
Ashley Whetter
565c43d99b
Can run with tox 4
4 years ago
Ashley Whetter
7872ed00b0
Can link to parameters of generic base classes
4 years ago
Ashley Whetter
643fed0ccd
Can resolve the qualified paths of parameters to generics
...
Closes #265
4 years ago
Ashley Whetter
23bee3db99
Added support for Sphinx 3.5
4 years ago
Joseph Yu
aeecc3e3e4
Added autoapi-skip-member example
4 years ago
Joseph Yu
5435536988
Multiline string are displayed correctly
4 years ago
Joseph Yu
b9a6fcd350
Minor internal test warnings fixes
4 years ago
Ashley Whetter
05dde9584c
Version 1.7.0
4 years ago
Ashley Whetter
471c870a53
Do not inherit redundant docstrings
...
Closes #240
4 years ago