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
Eric Holscher
b24293e545
Start using pydocstyle for Python doc generation
2016-06-09 15:44:30 -07:00
Eric Holscher
51fe162fb0
Cleanup to address review
2015-06-21 23:03:45 -04:00
Eric Holscher
5d861d13d8
Clean up handling of python args/params.
2015-06-10 14:37:17 -07:00
Eric Holscher
f60b7d8880
Add ability to configure options of display of objects.
2015-06-10 13:58:52 -07:00
Eric Holscher
bdae9f083c
Add ability to hide undocumented methods, etc.
2015-06-10 13:33:42 -07:00
Eric Holscher
1cde5590eb
Clean up how we render templates.
...
* Add top_level_object as global concept.
* Fix toctree generation
* Add passing of options to rendering
2015-06-10 13:13:34 -07:00
Eric Holscher
5ca2ee76a5
Refactor into nicer top-level interface to the Domains.
...
Languages refactored:
* Python
* JS
2015-06-06 16:11:49 -07:00
Eric Holscher
677df52c46
Show toc for now
2015-04-23 15:57:17 -07:00
Eric Holscher
0404c4723d
Reindent
2015-04-23 15:52:38 -07:00
Eric Holscher
d1dc81b8ba
Clean up python templates
2015-04-23 15:37:02 -07:00
Eric Holscher
aa62ad9af7
Sizable refactor of the autoapi tooling.
...
Standard template context and rendering. Also refactor YAML loading for new YAML formats.
2015-04-23 13:31:03 -07:00
Eric Holscher
d21b62937b
Clean up the python code more.
2015-04-22 10:12:05 -07:00
Eric Holscher
09097cf364
Fix Python support
2015-04-20 22:54:32 -07:00
Eric Holscher
8b177e5a9e
Updates for python stuff
2015-03-31 17:01:41 -07:00
