Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-11 19:10:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
726 Commits 14 Branches 43 Tags 5 MiB
434ef8305a
Commit Graph

64 Commits

Author SHA1 Message Date
Ashley Whetter
1ae7b78128 Fix class overrides not rendering correctly 2023-05-22 19:58:40 -07:00
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>
 2023-01-04 20:35:40 -08:00
Ashley Whetter
a23e2ffe73 Render Python properties with the property directive 
Fixes #352.
 2022-09-27 15:57:44 -07:00
Ashley Whetter
38c2089476 Removed prepare_docstring filter used for testing 2021-07-31 18:25:25 -07:00
Ashley Whetter
2c5c87157a Explicitly use the domain for generated directives 
Closes #292
 2021-06-27 17:25:36 -07:00
Ashley Whetter
5faec73073 Fixed error when parsing a class with no constructor 2021-06-21 23:10:52 -07:00
Sam Morley-Short
3fb14a24fc Added attribute summary table to python module template 2021-04-12 20:34:33 -07:00
Ashley Whetter
7872ed00b0 Can link to parameters of generic base classes 2021-03-19 23:55:35 -07:00
Joseph Yu
5435536988 Multiline string are displayed correctly 2021-03-19 22:03:04 -07:00
Ashley Whetter
24109875e1 The overload signatures of __init__ methods are documented 
Fixes #260
 2021-01-31 15:34:40 -08:00
Ashley Whetter
a8d07b610f Can edit the Jinja environment 
Closes #200
 2020-11-13 22:47:32 -08:00
Taku Fukada
5bb4ff2c02 Refine overload support 2020-08-17 12:48:36 -07:00
Taku Fukada
7270718374 Add support for overloaded functions 2020-08-17 12:48:36 -07:00
Ashley Whetter
ac70ea056e Fixed incorrect formatting of properties on generated method directives. 2020-07-31 23:28:53 -07:00
Ashley Whetter
3faa27053b Fixed return types not showing for methods. 
Fixes #219
 2020-07-11 19:27:59 -07:00
lhfriedman
c51fb3f737 added scoped keywords 
see issue 213 (https://github.com/readthedocs/sphinx-autoapi/issues/213)
 2020-06-07 18:57:26 -07:00
Ashley Whetter
ea150af1da Fixed incorrect formatting with private inheritance diagrams 
Fixes #195
 2020-05-16 17:51:09 -07:00
Ashley Whetter
4ba45cfacb Can document inherited members 
Closes #183
 2020-02-01 12:53:40 -08:00
Ashley Whetter
c5d5fb5346 Made passing of options to templates more sane 2020-01-25 17:36:06 -08:00
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
 2020-01-25 14:38:22 -08:00
Ashley Whetter
076427e6ae Added inheritance diagrams support 
Close #140
 2020-01-11 17:29:36 -08:00
Ashley Whetter
46c577eda1 Support for async and other Sphinx 2.1 method directive options 2019-07-17 20:59:20 -07:00
Ashley Whetter
589826e90c Can override ignoring local imports in modules by using __all__ 2019-06-23 12:36:58 -07:00
Ashley Whetter
9d45eed4d0 Fixed incorrect formatting of functions and methods 2019-06-23 11:55:15 -07:00
Ashley Whetter
b90284f0fe Support basic type annotations 
Closes #139
 2019-04-21 21:58:25 -07:00
Ashley Whetter
a4f798183c Fixed private submodules displaying when private-members turned off 
Also fixed whitespace issues in templates.
 2019-03-05 22:52:13 -08:00
Ashley Whetter
8d4fb4b1c3 Can document a public python API 
Closes #153
 2018-08-13 12:18:56 -07:00
Ashley Whetter
c3ef72ee14 Fixed nested classes not getting displayed in autogenerated docs 2018-08-07 14:39:38 -07:00
Ashley Whetter
7dd822eef4 Can still link to public items in private modules 2018-08-06 15:02:01 -07:00
Ashley Whetter
75ebcfc903 private-members also controls private subpackages and submodules 
Closes #150
 2018-08-06 14:52:42 -07:00
Ashley Whetter
4edf45af35 Added support for static and class methods 2018-08-06 14:19:12 -07:00
Ashley Whetter
9cb2f7d50e Methods include self in their arguments 
autodoc does this by default so it makes sense to do it in autoapi also.
 2018-08-06 14:19:12 -07:00
Ashley Whetter
d8f4847a5c
Added support for detecting Python exceptions (#147) 
Closes #145
 2018-07-31 16:57:24 -07:00
Ashley Whetter
6b8ccf62ae Fixed filtered classes and attributes getting displayed 2018-07-24 12:05:57 -07:00
Ashley Whetter
f2d3352801 Fixed incorrect display of long lists 
Stop pretty printing because the annotation option cannot accept
multiline strings.
 2018-07-16 12:45:17 -07:00
Ashley Whetter
b19b9ea28b Extended ast parsing with astroid 2018-05-08 22:41:35 -07:00
Anthony
ae1c6276df
Merge pull request #116 from AWhetter/py_hierarchy 
Py hierarchy
 2017-11-09 16:24:09 -07:00
Ashley Whetter
7b3e6fca6d Added basic class signature discovery 2017-11-09 14:18:11 -08:00
Ashley Whetter
b792463cc9 Can turn off autoapisummary directives in output 2017-11-09 12:48:21 -08:00
Ashley Whetter
4adcdc5351 Python documentation is now hierarchical 2017-11-09 12:48:21 -08:00
Ashley Whetter
958fe10103 Added autoapisummary directive 2017-11-09 12:21:52 -08:00
Eric Holscher
86a4de1668 Don’t show modules with no content. 2017-06-29 10:45:54 -07:00
Eric Holscher
3233bc0ac7 Fix templates to nest functions and use short names 2017-06-27 17:12:17 -07:00
Eric Holscher
e8514dfee2 Use shortname for methods 2016-11-04 15:44:47 -07:00
Eric Holscher
5901291d3f Remove nested parse 2016-11-04 15:37:46 -07:00
Eric Holscher
491f8c9065 Keep nested-parse 2016-11-04 15:34:48 -07:00
Eric Holscher
ffb2130b55 Implement prepare_docstring filter that wraps Sphinx's 
This allows us to output docstrings in a reasonable fashion.
 2016-11-04 15:17:50 -07:00
Eric Holscher
b6dc3d23d8 Clean up auto-tocing 2016-11-03 13:13:36 -07:00
Anthony Johnson
f607d5e1db Improvements to pydocstyle Python parsing 
* Moves relative path parsing away from the base mapper implementation
* Change argument parsing from splitting first line of source with ',' to use
  AST traversal instead. This is not complete, but mostly PoC for now. Full
  traversal into argument type nodes will allow us to get nested dict() etc.
  We should open a ticket to track this work
* Cleans up some of the templates to reduce duplicate titles
* Adds a directive for nesting rST from constructs that might have headings.
  Remove the first heading in this case to address the case where a module has a
  docstring with a heading up front
* Adds tests
* Replaces example module with module that has more failing cases of parsing

Closes #78
Fixes #80
Fixes #81
Fixes #82
Fixes #83
Fixes #84
Fixes #85
 2016-11-02 16:29:28 -07:00
Eric Holscher
3aa1747795 Template updates. 2016-08-25 16:23:48 -07:00