Ashley Whetter
a6558dcfc2
Various fixes for own page output
...
Also added tests for own page output.
Fix some inherited members always being rendered.
Own page members of an entity are linked to after the docstring
of the parent entity.
Fix entities below the "class" level that have their own page
from rendering incorrectly.
Rename "single page output" to "own page output". An entity does
not have a "single page" when its members are spread across
their own pages.
Properties are linked to on their parent classes page.
Children not present in `__all__` are not rendered.
Fixed emitting ignore event twice for methods.
Corrected documentation around `imported-members` to reflect that it
applies only to objects imported into a package, not modules.
Fixed path error on Windows.
2 months ago
Ashley Whetter
93fb571a7e
Basic tests for single page rendering
2 months ago
laggykiller
823c146b3a
Correct handling of `__init__.pyi`
...
Closes #405
4 months ago
Ashley Whetter
bbb50f68ae
Reformatted to latest stable black style
4 months ago
Ashley Whetter
4d1bec044a
Removed support for Python 3.7
8 months ago
Niels Wouda
cf8abe579f
Import fallback for older versions of Sphinx
8 months ago
Niels Wouda
0186a3c978
Replace usage of deprecated sphinx.util.status_iterator
8 months ago
Ashley Whetter
85739d513e
Switched to Google style docstrings
1 year ago
Ashley Whetter
a43c6fde2b
Switched linter from pylint to ruff
1 year ago
Ashley Whetter
58d653e557
Added basic type checking
1 year ago
Ashley Whetter
3f8730aadd
Fix tests
1 year ago
Ashley Whetter
94b255aecc
Added support for Python 3.11
1 year ago
Ashley Whetter
a23e2ffe73
Render Python properties with the property directive
...
Fixes #352 .
2 years ago
Ashley Whetter
517a6be383
Stop calling ``autodoc-process-docstring`` when docstring is empty
2 years ago
Ashley Whetter
6028cb104c
Fail elegantly when no source files are found
...
Fixes #324
2 years ago
Ashley Whetter
7d7f042805
Fixed possible incorrect indentation in generated documentation.
...
Closes #299 .
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
613eff53a7
Fixed type annotations being shown for only a single module
...
Closes #273
3 years ago
René Fritze
5777e43347
remove (sub-) types for "Unknown type" warnings
3 years ago
René Fritze
dbd1e9dfe6
Adds a subtype to all `logger.warning` calls
3 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.
3 years ago
Ashley Whetter
a0591adae4
Represent overload typehints more accurately
3 years ago
Ashley Whetter
bf8f50dc97
Fixed type hints still showing when setting autodoc_typehints
...
Closes #273
3 years ago
Ashley Whetter
7872ed00b0
Can link to parameters of generic base classes
3 years ago
Ashley Whetter
78b79583af
Implmented basic incremental building
...
Closes #191
4 years ago
Ashley Whetter
6f0299356a
Can use type hints as parameter types and return types
4 years ago
Ashley Whetter
8e4cd49e1a
Dropped support for Python 2 and Sphinx 1.x/2.x.
...
Removed all old compatibility code.
4 years ago
Ashley Whetter
b52378fa51
Added autoapi_member_order option
...
Closes #201
4 years ago
Ashley Whetter
9008db48e5
Added assertion to assist with import resolution debugging
4 years ago
Olivier Samyn
d71ac5f250
fix: Make the linter happy
4 years ago
Olivier Samyn 🎻
7ca958fe57
feat: Support implicit namespaces for python >= 3.3
4 years ago
Ashley Whetter
a122f00d4a
Fix linting
5 years ago
Daniel Daniels
a114af76dc
Added autoapi-skip-member event
5 years ago
Ashley Whetter
02b0c0a098
Made it more clear which file causes an error
5 years ago
Ashley Whetter
46c577eda1
Support for async and other Sphinx 2.1 method directive options
5 years ago
Ashley Whetter
a4f798183c
Fixed private submodules displaying when private-members turned off
...
Also fixed whitespace issues in templates.
5 years ago