0ac4dc5389
Fix kw-only marker getting ignored if first in the signature ( #340 )
...
Closes : #328
2 years ago
c40c3edd5c
Mark extension as parallel_read_safe ( #332 )
2 years ago
075736619f
Fix typos ( #331 )
2 years ago
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
185876a047
Limit signatures to 60 characters in summaries ( #311 )
2 years ago
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
517a6be383
Stop calling ``autodoc-process-docstring`` when docstring is empty
2 years ago
6028cb104c
Fail elegantly when no source files are found
...
Fixes #324
2 years ago
685d1d34c8
Updated to latest black formatting
2 years ago
19d217e177
Version 1.8.4
3 years ago
948f753a20
Fixed compatibility with astroid 2.7+.
...
Fixes #301
3 years ago
4d8f6387ca
Version 1.8.3
3 years ago
38c2089476
Removed prepare_docstring filter used for testing
3 years ago
7d7f042805
Fixed possible incorrect indentation in generated documentation.
...
Closes #299 .
3 years ago
354535190c
Version 1.8.2
3 years ago
2c5c87157a
Explicitly use the domain for generated directives
...
Closes #292
3 years ago
26b7d729a2
Fixed AttributeError using inheritance diagrams on a module with plain imports
...
Fixes #289
3 years ago
17ffa2d1b6
Fixed failure to build out of source conf.py files
...
Closes #293
3 years ago
08e61b93ef
Fixed displaying "self" in class signatures
3 years ago
5faec73073
Fixed error when parsing a class with no constructor
3 years ago
83b1260e67
Version 1.8.1
3 years ago
613eff53a7
Fixed type annotations being shown for only a single module
...
Closes #273
3 years ago
48ec2b341e
Version 1.8.0
3 years ago
3fb14a24fc
Added attribute summary table to python module template
3 years ago
57253a9f84
Generate rst files in src directory
3 years ago
86a6d1059c
Refactored dotnet error to raise an exception properly
3 years ago
5777e43347
remove (sub-) types for "Unknown type" warnings
3 years ago
dbd1e9dfe6
Adds a subtype to all `logger.warning` calls
3 years ago
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.
3 years ago
66f3734afa
Start testing in Github Actions
3 years ago
826bb2badd
Converted tests to pytest style
3 years ago
9372bdb9f1
Package with PEP-517
3 years ago
a0591adae4
Represent overload typehints more accurately
3 years ago
7541f922ae
Fixed data annotations causing pickle or deepcopy errors
...
Closes #261
3 years ago
bf8f50dc97
Fixed type hints still showing when setting autodoc_typehints
...
Closes #273
3 years ago
7872ed00b0
Can link to parameters of generic base classes
3 years ago
643fed0ccd
Can resolve the qualified paths of parameters to generics
...
Closes #265
3 years ago
5435536988
Multiline string are displayed correctly
3 years ago
b9a6fcd350
Minor internal test warnings fixes
3 years ago
05dde9584c
Version 1.7.0
3 years ago
471c870a53
Do not inherit redundant docstrings
...
Closes #240
3 years ago
24109875e1
The overload signatures of __init__ methods are documented
...
Fixes #260
3 years ago
73bb2d6105
The fully qualified path of objects are included type annotations
3 years ago
731323c2a4
Version 1.6.0
3 years ago
a8d07b610f
Can edit the Jinja environment
...
Closes #200
4 years ago
06a1969d11
Fixed autodoc directives documenting properties as methods
4 years ago
e281137654
Fixed raising unnecessary deprecation warning
...
Closes #244
4 years ago
78b79583af
Implmented basic incremental building
...
Closes #191
4 years ago
5ee7dbef59
Correctly parse Metaclasses
...
Fixes #246
4 years ago
6f0299356a
Can use type hints as parameter types and return types
4 years ago
8e4cd49e1a
Dropped support for Python 2 and Sphinx 1.x/2.x.
...
Removed all old compatibility code.
4 years ago
40ebbc965f
Version 1.5.1
4 years ago
f986f02105
Fix inheritance diagram from module
4 years ago
0667de4037
Release preparation
4 years ago
fc634afc0d
Fix formatting after black upgrade
4 years ago
0a5b84b8be
autoapi_file_patterns is in order of preference
...
Closes #243
4 years ago
5bb4ff2c02
Refine overload support
4 years ago
8f4a4b1f0c
Refactor the child function/method parsing loop
4 years ago
78db701450
Ignore some pylint checks
4 years ago
7270718374
Add support for overloaded functions
4 years ago
a58b7ed45b
Update documenters.py
4 years ago
3b35293f9c
Make NestedParse not to wrap their content with a paragraph
4 years ago
b2b5f62847
Fix #234 : Inject TOCs just after doctrees are read
4 years ago
8640355f3d
autoapisummary directive inherits from autosummary for future stability
4 years ago
8d841664ed
Fixed every toctree entry getting added as a new list
4 years ago
ac70ea056e
Fixed incorrect formatting of properties on generated method directives.
4 years ago
d08522c525
Added default golang ingore pattern to remove unit tests by default ( #231 )
4 years ago
f5182a2291
Declare the extension as parallel safe
...
Closes #222
4 years ago
3faa27053b
Fixed return types not showing for methods.
...
Fixes #219
4 years ago
9bd08a2bc1
Version 1.4.0
4 years ago
c51fb3f737
added scoped keywords
...
see issue 213 (https://github.com/readthedocs/sphinx-autoapi/issues/213 )
4 years ago
975ac49dc0
Inheritance diagrams can follow imports
...
Closes #193
Closes #208
4 years ago
ea150af1da
Fixed incorrect formatting with private inheritance diagrams
...
Fixes #195
4 years ago
cd9b9ca0fe
Added the imported-members AutoAPI option
...
Closes #204
4 years ago
fca36aa664
Classes and methods inherit docstrings from their parent
...
Closes #203
4 years ago
b52378fa51
Added autoapi_member_order option
...
Closes #201
4 years ago
2f87d5ef82
Added __version_info__ and single source version
4 years ago
e0b41e00a7
Add __version__ to __init__.py
4 years ago
0d95377bbf
Accept template directory relative to conf.py
...
Closes #184
4 years ago
9008db48e5
Added assertion to assist with import resolution debugging
4 years ago
428e8526f0
Fixed Python 2 support
4 years ago
4ba45cfacb
Can document inherited members
...
Closes #183
4 years ago
c5d5fb5346
Made passing of options to templates more sane
4 years ago
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
4 years ago
076427e6ae
Added inheritance diagrams support
...
Close #140
4 years ago
fc1d78f758
Python 3.8 support
4 years ago
f8b6a6151c
arg and kwargs annotations can be read from the function type comment
4 years ago
9c91de9370
Ignore extra argument type annotations
...
Closes #186
4 years ago
d40122948b
Remaining rtfd -> readthedocs replacements
4 years ago
b5b2b2f08e
Make the linter happy again
4 years ago
d71ac5f250
fix: Make the linter happy
4 years ago
cca3a781ee
fix: correct stop condition in sphinx <2.0 and add a stop guard.
4 years ago
7ca958fe57
feat: Support implicit namespaces for python >= 3.3
4 years ago
74889a9d07
"Invalid desc node" warning no longer raised for autodoc-style directives
5 years ago
28301f1ba4
Fix linting again
5 years ago
520f3b0469
Fixed formatting
5 years ago
a122f00d4a
Fix linting
5 years ago
a114af76dc
Added autoapi-skip-member event
5 years ago
f6649ebde4
Include methods in child class ( #176 )
5 years ago
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.
5 years ago
Jeff Epler
Ash Berlin-Taylor
Kian-Meng Ang
Nathan Glenn
Zachary Moon
Mathieu Bouzard
Ashley Whetter
Sam Morley-Short
Kamil Breguła
René Fritze
Joseph Yu
Brent Yi
Taku Fukada
Haggai Nuchi
Thorsten Beier
lhfriedman
Matthijs van der Burgh
Ashley Whetter
Olivier Samyn
Olivier Samyn 🎻
Daniel Daniels
谷月轩
Armand BENETEAU