Commit Graph

13 Commits

Author SHA1 Message Date
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
Ashley Whetter
46c577eda1 Support for async and other Sphinx 2.1 method directive options 2019-07-17 20:59:20 -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
b19b9ea28b Extended ast parsing with astroid 2018-05-08 22:41:35 -07:00
Eric Holscher
e8514dfee2 Use shortname for methods 2016-11-04 15:44:47 -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
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
Eric Holscher
b24293e545 Start using pydocstyle for Python doc generation 2016-06-09 15:44:30 -07:00