92437c9af7
Removed old pylint pragmas
1 year ago
a22ae9262a
Removed support for documenting languages other than Python
...
For the reasons why, see #248
1 year ago
c3c6e15d16
Added missing changelog entry
1 year ago
86cf7e2b87
Fix getting 'orig_path' for 'viewcode_follow_imported'
1 year ago
1715dfe0b5
Fix "document isn't included" warning when using autoapi_add_toctree_entry
...
Closes #319
1 year ago
336f52e2e9
Added missing deprecation warning for other language support
1 year ago
85739d513e
Switched to Google style docstrings
2 years ago
6b16e02de4
Let Sphinx handle adding domain directives to the toctree ( #374 )
...
* Remove ability to add domains to the toctree
* Add towncrier news fragment
2 years ago
58d653e557
Added basic type checking
2 years ago
3f8730aadd
Fix tests
2 years ago
94b255aecc
Added support for Python 3.11
2 years ago
377a38550f
Add option autoapi_add_objects_to_toctree ( #284 )
2 years ago
c40c3edd5c
Mark extension as parallel_read_safe ( #332 )
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
685d1d34c8
Updated to latest black formatting
3 years ago
17ffa2d1b6
Fixed failure to build out of source conf.py files
...
Closes #293
3 years ago
613eff53a7
Fixed type annotations being shown for only a single module
...
Closes #273
3 years ago
57253a9f84
Generate rst files in src directory
4 years ago
b9a6fcd350
Minor internal test warnings fixes
4 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
8e4cd49e1a
Dropped support for Python 2 and Sphinx 1.x/2.x.
...
Removed all old compatibility code.
4 years ago
0667de4037
Release preparation
4 years ago
b2b5f62847
Fix #234 : Inject TOCs just after doctrees are read
4 years ago
f5182a2291
Declare the extension as parallel safe
...
Closes #222
4 years ago
cd9b9ca0fe
Added the imported-members AutoAPI option
...
Closes #204
4 years ago
b52378fa51
Added autoapi_member_order option
...
Closes #201
4 years ago
0d95377bbf
Accept template directory relative to conf.py
...
Closes #184
5 years ago
4ba45cfacb
Can document inherited members
...
Closes #183
5 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
5 years ago
076427e6ae
Added inheritance diagrams support
...
Close #140
5 years ago
7ca958fe57
feat: Support implicit namespaces for python >= 3.3
5 years ago
520f3b0469
Fixed formatting
5 years ago
a122f00d4a
Fix linting
5 years ago
a114af76dc
Added autoapi-skip-member event
5 years ago
be324b10bf
Made dependencies of other languages optional ( #171 )
...
* Fixes #170
* Makes sphinxcontrib-golangdomain and
sphinxcontrib-dotnetdomain to be optional
packages
* Adds check that appropriate dependencies of
a specified api-type installed during the
extension initialisation
* Adds appropriate tests
5 years ago
02b0c0a098
Made it more clear which file causes an error
5 years ago
86a2aeb6d7
Fixed some unicode decode errors
5 years ago
fd1cef5ced
Updated Autodoc directives for Sphinx 2.1 features
...
Added autoapidecorator directive.
Abides by autodoc_docstring_signature.
autoapifunction documents async functions.
Closes #166 .
5 years ago
0cee730693
Do not add a toctree entry when not generating docs
6 years ago
f77bf19800
Added Black formatting
6 years ago
c4fe76ef23
Removed references to old css and js files
6 years ago
2cf80b1569
Fixed Sphinx logger deprecation warnings
6 years ago
aac53178eb
Fixed error parsing files with unicode docstrings
6 years ago
c3f3cc33de
Added viewcode support for imported members
6 years ago
8d4fb4b1c3
Can document a public python API
...
Closes #153
6 years ago
9e9c28e15b
Can opt to write manual documentation
6 years ago
8a965bb15a
Fixed lint error
6 years ago
Ashley Whetter
Z-Fran
Brandon Wiebe
Jakob Lykke Andersen
Ash Berlin-Taylor
Nathan Glenn
Kamil Breguła
Joseph Yu
Taku Fukada
Olivier Samyn 🎻
Daniel Daniels
Ashley Whetter