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
5 years ago
fc1d78f758
Python 3.8 support
5 years ago
f8b6a6151c
arg and kwargs annotations can be read from the function type comment
5 years ago
9c91de9370
Ignore extra argument type annotations
...
Closes #186
5 years ago
d40122948b
Remaining rtfd -> readthedocs replacements
5 years ago
b5b2b2f08e
Make the linter happy again
5 years ago
d71ac5f250
fix: Make the linter happy
5 years ago
cca3a781ee
fix: correct stop condition in sphinx <2.0 and add a stop guard.
5 years ago
7ca958fe57
feat: Support implicit namespaces for python >= 3.3
5 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
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
34d02faa2f
Custom argument formatting
...
Closes #162
5 years ago
46c577eda1
Support for async and other Sphinx 2.1 method directive options
5 years ago
9fc96f2ddf
Added support for Sphinx 2.1
5 years ago
589826e90c
Can override ignoring local imports in modules by using __all__
5 years ago
9d45eed4d0
Fixed incorrect formatting of functions and methods
5 years ago
2084f695bd
Can set an empty function signature in autodoc directives
5 years ago
cac774c072
Added type annotation support to autodoc directives
5 years ago
b90284f0fe
Support basic type annotations
...
Closes #139
5 years ago
b5dfea1c6d
Removed some dead code
5 years ago
0cee730693
Do not add a toctree entry when not generating docs
5 years ago
3db1fd1226
Fixed error when an invalid object is given to an autodoc directive
5 years ago
7230330686
Documentation overhaul
5 years ago
dd58809d89
Added support for parsing stub files
...
Closes #100
5 years ago
3b299be332
Tidied up index page
5 years ago
8242f2ea13
Added Sphinx 2.0 support
5 years ago
c6b46969f8
Fixed decoding of binary data on Python 2
...
Fixes #159
5 years ago
a4f798183c
Fixed private submodules displaying when private-members turned off
...
Also fixed whitespace issues in templates.
5 years ago
b94acc6019
Properly pass file patterns to godocjson utility ( #161 )
...
* Properly pass file patterns to godocjson utility
* Go integration tests fixed during to new *ignore* argument
5 years ago
80fd76bd1e
Fixed false warning when importing a local module
5 years ago
68e1f79ed5
Added render log messages
5 years ago
f77bf19800
Added Black formatting
6 years ago
Ashley Whetter
Matthijs van der Burgh
Ashley Whetter
Olivier Samyn
Olivier Samyn 🎻
Daniel Daniels
谷月轩
Armand BENETEAU
Alexander Gor