Commit Graph

25 Commits (31d4beb9597f5295a2cb76b91fe222f938ddbc87)

Author SHA1 Message Date
lhfriedman c51fb3f737 added scoped keywords
see issue 213 (https://github.com/readthedocs/sphinx-autoapi/issues/213)
4 years ago
Ashley Whetter 4ba45cfacb Can document inherited members
Closes #183
5 years ago
Ashley Whetter 589826e90c Can override ignoring local imports in modules by using __all__ 5 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 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 b792463cc9 Can turn off autoapisummary directives in output 7 years ago
Ashley Whetter 4adcdc5351 Python documentation is now hierarchical 7 years ago
Eric Holscher 86a4de1668 Don’t show modules with no content. 7 years ago
Eric Holscher 3233bc0ac7 Fix templates to nest functions and use short names 7 years ago
Eric Holscher ffb2130b55 Implement prepare_docstring filter that wraps Sphinx's
This allows us to output docstrings in a reasonable fashion.
8 years ago
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
8 years ago
Eric Holscher 3aa1747795 Template updates. 8 years ago
Eric Holscher 51fe162fb0 Cleanup to address review 9 years ago
Eric Holscher f60b7d8880 Add ability to configure options of display of objects. 9 years ago
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
9 years ago
Eric Holscher 5ca2ee76a5 Refactor into nicer top-level interface to the Domains.
Languages refactored:

* Python
* JS
9 years ago
Eric Holscher 677df52c46 Show toc for now 10 years ago
Eric Holscher 0404c4723d Reindent 10 years ago
Eric Holscher d1dc81b8ba Clean up python templates 10 years ago
Eric Holscher aa62ad9af7 Sizable refactor of the autoapi tooling.
Standard template context and rendering. Also refactor YAML loading for new YAML formats.
10 years ago
Eric Holscher d21b62937b Clean up the python code more. 10 years ago
Eric Holscher 09097cf364 Fix Python support 10 years ago
Eric Holscher 8b177e5a9e Updates for python stuff 10 years ago