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
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
dfe82ae94e
Dropped support for Sphinx<1.6
6 years ago
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
9fe8489bfe
Fixed lint errors
6 years ago
1caa6d22e1
Fixed some import chains failing to resolve depending on resolution order
6 years ago
3b52975340
Fixed unicode decoding on Python 3.7
6 years ago
c6f34398b5
Fixed autodoc not documenting top level packages or modules
6 years ago
aac53178eb
Fixed error parsing files with unicode docstrings
6 years ago
66cf2ed4d0
Fixed autodoc not documenting anything in submodules or subpackages
6 years ago
a1f1fd8651
Fixed properly resolving definitions imported more than once
6 years ago
2799fb32cc
Fixed error when documenting something that's imported in more than one place
6 years ago
007ef746f4
Fixed linter again
6 years ago
fb8892ccad
Fixed lint error
6 years ago
c3f3cc33de
Added viewcode support for imported members
6 years ago
92b4ea9dc8
Fixed linking to builtin bases
6 years ago
616267726b
No longer document __init__ attributes without a docstring
...
Fixes #146
Also fixed duplicates when a property is set in __init__.
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
b789dcaa73
Fixed autodoc being unable to discover nested classes
6 years ago
c3ef72ee14
Fixed nested classes not getting displayed in autogenerated docs
6 years ago
8a965bb15a
Fixed lint error
6 years ago
bc65e766c3
Made it easier to remove default index page
...
Also removed autoapi_add_api_root_toctree config option
because it is less useful now.
Closes #152
6 years ago
7dd822eef4
Can still link to public items in private modules
6 years ago
75ebcfc903
private-members also controls private subpackages and submodules
...
Closes #150
6 years ago
6ffec93569
Fixed lint errors
6 years ago
4ac85dd7af
Added autoapi directives for Python
6 years ago
4edf45af35
Added support for static and class methods
6 years ago
9cb2f7d50e
Methods include self in their arguments
...
autodoc does this by default so it makes sense to do it in autoapi also.
6 years ago
af4263457e
Full path is resolved for bases from same module
6 years ago
a1825cd98d
Fixed astroid 2.0 compatibility
...
Closes #148
6 years ago
d8f4847a5c
Added support for detecting Python exceptions ( #147 )
...
Closes #145
6 years ago
6b8ccf62ae
Fixed filtered classes and attributes getting displayed
6 years ago
f2d3352801
Fixed incorrect display of long lists
...
Stop pretty printing because the annotation option cannot accept
multiline strings.
6 years ago
9dd26fd32b
Fixed running incorrect jsdoc command on Windows
...
Issue #125 .
jsdoc on windows is deployed as jsdoc.cmd
6 years ago
974bae1f20
Support specifying package directories in `autoapi_dirs` ( #135 )
...
* Support specifying package directories as well
Fixes #108 .
* Use os.sep instead of the hardcoded '/'
This was making the tests fail on Windows because the necessary '/'
replacements were not happening on Windows due to os.sep being '\\'.
6 years ago
ea6f1d322e
Fix lint errors
6 years ago
6ca62f16c9
Can control how __init__ docstring is displayed
6 years ago
6eb18467f7
Fixed undoc members logic
6 years ago
9f6f7d0b5d
Added support for viewcode
6 years ago
741dfaffb3
Source files no longer need to be in sys.path
6 years ago
b19b9ea28b
Extended ast parsing with astroid
6 years ago
ea8efe91dc
Fix lint errors
...
There should be no behavioural changes - this is just explicitly returning what would've been returned anyway.
6 years ago
b06d4f801b
Started autoloading autosummary extension
7 years ago
5075467441
Formats napoleon docstrings in Python
7 years ago
ae1c6276df
Merge pull request #116 from AWhetter/py_hierarchy
...
Py hierarchy
7 years ago
7b3e6fca6d
Added basic class signature discovery
7 years ago
b792463cc9
Can turn off autoapisummary directives in output
7 years ago
4adcdc5351
Python documentation is now hierarchical
7 years ago
b5be7b6d9a
Fixed a warning
7 years ago
958fe10103
Added autoapisummary directive
7 years ago
5a86878811
Fixed Python subpackages having incomplete names
7 years ago
e5cce2c7dd
Fix lint
7 years ago
d803b28d00
Kill janky napolean overlay
7 years ago
3531f5560a
Merge remote-tracking branch 'origin/master' into cleanup-june
7 years ago
86a9ffdd60
Fixed lint errors
7 years ago
ae1e4f556d
Fixed usage of deprecated status_indicator
...
This fixes a compatibiity issue with Sphinx 1.7
7 years ago
a1a3f05202
Fix for Sphinx 1.6
7 years ago
3875cf495d
Fix noting the toctree
7 years ago
21a82718ab
Fix linting
7 years ago
8c1016f8c7
Fix linting
7 years ago
ed57a216ec
Fix lint
7 years ago
0e3e5df437
Fix linting
7 years ago
86a4de1668
Don’t show modules with no content.
7 years ago
4428ecd6e8
Add ability to process Napolean docstrings.
7 years ago
efb541f78a
Add ability to add API to top-level TOC.
7 years ago
3233bc0ac7
Fix templates to nest functions and use short names
7 years ago
152ea1a521
Merge pull request #104 from rtfd/python-ast
...
Start altering the pydocstyle AST parser for our needs
7 years ago
e7a624254a
Merge pull request #106 from rtfd/fix-argument-call
...
Fix Python argument parsing for Call nodes
7 years ago
715b6662e5
Fix Python argument parsing for Call nodes
...
This previous was throwing exceptions in some cases where Attribute nodes were
used instead of Name nodes.
7 years ago
df74247128
Allow for toplevel module as Sphinx extension
...
Instead of requiring:
extensions = ['autoapi.extension']
This allows for the toplevel:
extensions = ['autoapi']
This is more intuitive for users, as extension is an internal concept.
7 years ago
2603729925
Fix some more parsing issues
7 years ago
0faeb500ee
More fixes
7 years ago
3c6e0e4015
Start altering the pydocstyle AST parser for our needs
...
This forks some of the pydocstyle AST parser into out mapper. Eventually, some
of the other operations such as parsing arguments and performing full name
lookup can be moved in as well. For now, this is not doing any extra assignment
tracking/etc, several of these operations will just throw this information out.
Refs #99
7 years ago
Armand BENETEAU
danields761
Ashley Whetter
Alexander Gor
Ashley Whetter
Ashley Whetter
fredbi
Sam Lai
Sam Lai
Anthony
Eric Holscher