Ashley Whetter
a122f00d4a
Fix linting
5 years ago
Daniel Daniels
a114af76dc
Added autoapi-skip-member event
5 years ago
谷月轩
f6649ebde4
Include methods in child class ( #176 )
5 years ago
Armand BENETEAU
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
danields761
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
Ashley Whetter
02b0c0a098
Made it more clear which file causes an error
5 years ago
Ashley Whetter
86a2aeb6d7
Fixed some unicode decode errors
5 years ago
Ashley Whetter
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
Ashley Whetter
34d02faa2f
Custom argument formatting
...
Closes #162
5 years ago
Ashley Whetter
46c577eda1
Support for async and other Sphinx 2.1 method directive options
5 years ago
Ashley Whetter
9fc96f2ddf
Added support for Sphinx 2.1
5 years ago
Ashley Whetter
589826e90c
Can override ignoring local imports in modules by using __all__
5 years ago
Ashley Whetter
9d45eed4d0
Fixed incorrect formatting of functions and methods
5 years ago
Ashley Whetter
2084f695bd
Can set an empty function signature in autodoc directives
6 years ago
Ashley Whetter
cac774c072
Added type annotation support to autodoc directives
6 years ago
Ashley Whetter
b90284f0fe
Support basic type annotations
...
Closes #139
6 years ago
Ashley Whetter
b5dfea1c6d
Removed some dead code
6 years ago
Ashley Whetter
0cee730693
Do not add a toctree entry when not generating docs
6 years ago
Ashley Whetter
3db1fd1226
Fixed error when an invalid object is given to an autodoc directive
6 years ago
Ashley Whetter
7230330686
Documentation overhaul
6 years ago
Ashley Whetter
dd58809d89
Added support for parsing stub files
...
Closes #100
6 years ago
Ashley Whetter
3b299be332
Tidied up index page
6 years ago
Ashley Whetter
8242f2ea13
Added Sphinx 2.0 support
6 years ago
Ashley Whetter
c6b46969f8
Fixed decoding of binary data on Python 2
...
Fixes #159
6 years ago
Ashley Whetter
a4f798183c
Fixed private submodules displaying when private-members turned off
...
Also fixed whitespace issues in templates.
6 years ago
Alexander Gor
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
6 years ago
Ashley Whetter
80fd76bd1e
Fixed false warning when importing a local module
6 years ago
Ashley Whetter
68e1f79ed5
Added render log messages
6 years ago
Ashley Whetter
f77bf19800
Added Black formatting
6 years ago
Ashley Whetter
c4fe76ef23
Removed references to old css and js files
6 years ago
Ashley Whetter
2cf80b1569
Fixed Sphinx logger deprecation warnings
6 years ago
Ashley Whetter
dfe82ae94e
Dropped support for Sphinx<1.6
6 years ago
Ashley Whetter
00894a959e
Overhauled Python import resolution logic
...
Stable in more complex cases.
Capable of giving more detailed warnings.
More closely matches real import logic.
Closes #156
6 years ago
Ashley Whetter
9fe8489bfe
Fixed lint errors
6 years ago
Ashley Whetter
1caa6d22e1
Fixed some import chains failing to resolve depending on resolution order
6 years ago
Ashley Whetter
3b52975340
Fixed unicode decoding on Python 3.7
6 years ago
Ashley Whetter
c6f34398b5
Fixed autodoc not documenting top level packages or modules
6 years ago
Ashley Whetter
aac53178eb
Fixed error parsing files with unicode docstrings
6 years ago
Ashley Whetter
66cf2ed4d0
Fixed autodoc not documenting anything in submodules or subpackages
6 years ago
Ashley Whetter
a1f1fd8651
Fixed properly resolving definitions imported more than once
6 years ago
Ashley Whetter
2799fb32cc
Fixed error when documenting something that's imported in more than one place
6 years ago
Ashley Whetter
007ef746f4
Fixed linter again
6 years ago
Ashley Whetter
fb8892ccad
Fixed lint error
6 years ago
Ashley Whetter
c3f3cc33de
Added viewcode support for imported members
6 years ago
Ashley Whetter
92b4ea9dc8
Fixed linking to builtin bases
6 years ago
Ashley Whetter
616267726b
No longer document __init__ attributes without a docstring
...
Fixes #146
Also fixed duplicates when a property is set in __init__.
6 years ago
Ashley Whetter
8d4fb4b1c3
Can document a public python API
...
Closes #153
6 years ago
Ashley Whetter
9e9c28e15b
Can opt to write manual documentation
6 years ago
Ashley Whetter
b789dcaa73
Fixed autodoc being unable to discover nested classes
6 years ago
Ashley Whetter
c3ef72ee14
Fixed nested classes not getting displayed in autogenerated docs
6 years ago