Commit Graph

131 Commits (bc71226c3bb8b6033902cbd1b4cdf8ae47d5b959)

Author SHA1 Message Date
Ashley Whetter bc71226c3b Render PEP-695 type aliases as TypeAlias assignments
Partially addresses #414
6 months ago
Ashley Whetter 007077a7db Refactor mapper classes into their bases
This separate used to exist to support parsing multiple languages,
which we no longer do.
6 months ago
Ashley Whetter a6558dcfc2 Various fixes for own page output
Also added tests for own page output.
Fix some inherited members always being rendered.
Own page members of an entity are linked to after the docstring
of the parent entity.
Fix entities below the "class" level that have their own page
from rendering incorrectly.
Rename "single page output" to "own page output". An entity does
not have a "single page" when its members are spread across
their own pages.
Properties are linked to on their parent classes page.
Children not present in `__all__` are not rendered.
Fixed emitting ignore event twice for methods.
Corrected documentation around `imported-members` to reflect that it
applies only to objects imported into a package, not modules.
Fixed path error on Windows.
6 months ago
Jorge Martinez 2a603b8ac0 Recursive rendering of children with their own page 6 months ago
Ashley Whetter 93fb571a7e Basic tests for single page rendering 6 months ago
Jorge Martinez Garrido ecd47ea456 Initial implementation of customisable single page output 6 months ago
Ashley Whetter a22ae9262a Removed support for documenting languages other than Python
For the reasons why, see #248
1 year ago
Ashley Whetter 1ae7b78128 Fix class overrides not rendering correctly 1 year ago
davfsa 1556b17ca8
Use the correct directives for a variable type and value (#353)
* Use the correct directives for a variable type and value

Co-authored-by: PerchunPak <perchunpak@gmail.com>

* Improve multiline value

* Add colons for strings

* Add another testcase

Co-authored-by: PerchunPak <perchunpak@gmail.com>
2 years ago
Ashley Whetter a23e2ffe73 Render Python properties with the property directive
Fixes #352.
2 years ago
Bruno P. Kinoshita c9edd8d1c6
Minor fixes (typos, http->https in links, types) (#348)
* Avoid http->https redirect, use https where possible

* Add autoapi_template_dir to existing array instead of re-declaring

* Typos

* Sphinx util uses int for verbosity in status_iterator

* Sphinx utils uses tuples for TypeField arguments
2 years ago
Ashley Whetter 38c2089476 Removed prepare_docstring filter used for testing 3 years ago
Ashley Whetter 2c5c87157a Explicitly use the domain for generated directives
Closes #292
3 years ago
Ashley Whetter 5faec73073 Fixed error when parsing a class with no constructor 3 years ago
Sam Morley-Short 3fb14a24fc Added attribute summary table to python module template 3 years ago
Ashley Whetter 7872ed00b0 Can link to parameters of generic base classes 4 years ago
Joseph Yu 5435536988 Multiline string are displayed correctly 4 years ago
Ashley Whetter 24109875e1 The overload signatures of __init__ methods are documented
Fixes #260
4 years ago
Ashley Whetter a8d07b610f Can edit the Jinja environment
Closes #200
4 years ago
Taku Fukada 5bb4ff2c02 Refine overload support 4 years ago
Taku Fukada 7270718374 Add support for overloaded functions 4 years ago
Ashley Whetter ac70ea056e Fixed incorrect formatting of properties on generated method directives. 4 years ago
Ashley Whetter 3faa27053b Fixed return types not showing for methods.
Fixes #219
4 years ago
lhfriedman c51fb3f737 added scoped keywords
see issue 213 (https://github.com/readthedocs/sphinx-autoapi/issues/213)
4 years ago
Ashley Whetter ea150af1da Fixed incorrect formatting with private inheritance diagrams
Fixes #195
4 years ago
Ashley Whetter 4ba45cfacb Can document inherited members
Closes #183
5 years ago
Ashley Whetter c5d5fb5346 Made passing of options to templates more sane 5 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
5 years ago
Ashley Whetter 076427e6ae Added inheritance diagrams support
Close #140
5 years ago
Ashley Whetter d40122948b Remaining rtfd -> readthedocs replacements 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
Ashley Whetter 46c577eda1 Support for async and other Sphinx 2.1 method directive options 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 b90284f0fe Support basic type annotations
Closes #139
5 years ago
Ashley Whetter 3b299be332 Tidied up index page 6 years ago
Ashley Whetter a4f798183c Fixed private submodules displaying when private-members turned off
Also fixed whitespace issues in templates.
6 years ago
Ashley Whetter 8d4fb4b1c3 Can document a public python API
Closes #153
6 years ago
Ashley Whetter c3ef72ee14 Fixed nested classes not getting displayed in autogenerated docs 6 years ago
Ashley Whetter 7dd822eef4 Can still link to public items in private modules 6 years ago
Ashley Whetter 75ebcfc903 private-members also controls private subpackages and submodules
Closes #150
6 years ago
Ashley Whetter 4edf45af35 Added support for static and class methods 6 years ago
Ashley Whetter 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
Ashley Whetter d8f4847a5c
Added support for detecting Python exceptions (#147)
Closes #145
6 years ago
Ashley Whetter 6b8ccf62ae Fixed filtered classes and attributes getting displayed 6 years ago
Ashley Whetter f2d3352801 Fixed incorrect display of long lists
Stop pretty printing because the annotation option cannot accept
multiline strings.
6 years ago
Ashley Whetter b19b9ea28b Extended ast parsing with astroid 6 years ago
Anthony ae1c6276df
Merge pull request #116 from AWhetter/py_hierarchy
Py hierarchy
7 years ago
Ashley Whetter 7b3e6fca6d Added basic class signature discovery 7 years ago
Ashley Whetter b792463cc9 Can turn off autoapisummary directives in output 7 years ago