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
Sam Morley-Short
3fb14a24fc
Added attribute summary table to python module template
2021-04-12 20:34:33 -07:00
Ashley Whetter
a8d07b610f
Can edit the Jinja environment
...
Closes #200
2020-11-13 22:47:32 -08: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
4ba45cfacb
Can document inherited members
...
Closes #183
2020-02-01 12:53:40 -08:00
Ashley Whetter
589826e90c
Can override ignoring local imports in modules by using __all__
2019-06-23 12:36:58 -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
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
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
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
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
51fe162fb0
Cleanup to address review
2015-06-21 23:03:45 -04:00
Eric Holscher
f60b7d8880
Add ability to configure options of display of objects.
2015-06-10 13:58:52 -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
