Commit Graph

34 Commits (f23b079e7d46be6495fb02a7cc3a25a96031c45e)

Author SHA1 Message Date
Ashley Whetter f23b079e7d Stop using xrefs in page titles
Closes #427
2 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.
3 months ago
Jorge Martinez 2a603b8ac0 Recursive rendering of children with their own page 3 months ago
Ashley Whetter 93fb571a7e Basic tests for single page rendering 3 months ago
Jorge Martinez Garrido ecd47ea456 Initial implementation of customisable single page output 3 months 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
Sam Morley-Short 3fb14a24fc Added attribute summary table to python module template 3 years ago
Ashley Whetter a8d07b610f Can edit the Jinja environment
Closes #200
4 years ago
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
4 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.
5 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 9 years ago
Eric Holscher 0404c4723d Reindent 9 years ago
Eric Holscher d1dc81b8ba Clean up python templates 9 years ago
Eric Holscher aa62ad9af7 Sizable refactor of the autoapi tooling.
Standard template context and rendering. Also refactor YAML loading for new YAML formats.
9 years ago
Eric Holscher d21b62937b Clean up the python code more. 9 years ago
Eric Holscher 09097cf364 Fix Python support 9 years ago
Eric Holscher 8b177e5a9e Updates for python stuff 9 years ago