Commit Graph

763 Commits (feat/single-page-option)
 

Author SHA1 Message Date
Ashley Whetter 4ba45cfacb Can document inherited members
Closes #183
4 years ago
Ashley Whetter c5d5fb5346 Made passing of options to templates more sane 4 years ago
Ashley Whetter 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
Ashley Whetter 076427e6ae Added inheritance diagrams support
Close #140
4 years ago
Ashley Whetter 3747596021 Fixed formatting 4 years ago
Ashley Whetter fc1d78f758 Python 3.8 support 4 years ago
Ashley Whetter f8b6a6151c arg and kwargs annotations can be read from the function type comment 4 years ago
Ashley Whetter 9c91de9370 Ignore extra argument type annotations
Closes #186
4 years ago
Ashley Whetter d40122948b Remaining rtfd -> readthedocs replacements 4 years ago
Ashley Whetter 3a415e2f58 More documentation tweaks 4 years ago
Ashley Whetter b5b2b2f08e Make the linter happy again 4 years ago
Ashley Whetter 4bccd1bfe7 Documentation tweaks 4 years ago
Olivier Samyn d71ac5f250 fix: Make the linter happy 4 years ago
Olivier Samyn cca3a781ee fix: correct stop condition in sphinx <2.0 and add a stop guard. 4 years ago
Olivier Samyn a836795d17 doc: Add autoapi_python_use_implicit_namespaces config value description
+
4 years ago
Olivier Samyn 5f085ca47f test: add implicit namespace checks 4 years ago
Olivier Samyn 🎻 7ca958fe57 feat: Support implicit namespaces for python >= 3.3 4 years ago
Ashley Whetter 4c927b2a3f
Minor fix in how_to.rst (#185) 4 years ago
Ashley Whetter 2af3d462bf Fixed formatting of the table in the tutorials 4 years ago
Yuji Tabata 7cc6b72c96
Minor fix in how_to.rst 5 years ago
Ashley Whetter daa5ce24a5 Version 1.2.1 5 years ago
Ashley Whetter 74889a9d07 "Invalid desc node" warning no longer raised for autodoc-style directives 5 years ago
Ashley Whetter e06fa71dbc Version 1.2.0 5 years ago
Ashley Whetter 28301f1ba4 Fix linting again 5 years ago
Ashley Whetter 520f3b0469 Fixed formatting 5 years ago
Ashley Whetter b8fddf9c0b Added some missing documentation 5 years ago
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
Ashley Whetter 900072e99b Added documentation for optional dependencies 5 years ago
Ashley Whetter 45ff03a3ad Disable linting for now 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
Eric Holscher a5d369aea4
Change rtfd -> readthedocs 5 years ago
Martín Gaitán 6b6aae95fc fix typo on subsection's title (#167) 5 years ago
Ashley Whetter 0b947a028e v1.1.0 5 years ago
Ashley Whetter 6629e0b10f Update appveyor to Python 3.7 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 6d39780ae4 Fixed tox setup 5 years ago
Ashley Whetter f3ab2ef6e2 Fixed some dead links in the README 5 years ago
Ashley Whetter 9735f43a8d v1.0.0 5 years ago
Ashley Whetter 2084f695bd Can set an empty function signature in autodoc directives 5 years ago
Ashley Whetter 6f4b4efef5 Corrected version to Python to skip tests for 5 years ago