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
6ffec93569
Fixed lint errors
2018-08-06 14:19:12 -07:00
Ashley Whetter
4ac85dd7af
Added autoapi directives for Python
2018-08-06 14:19:12 -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
af4263457e
Full path is resolved for bases from same module
2018-08-06 14:19:12 -07:00
Ashley Whetter
a1825cd98d
Fixed astroid 2.0 compatibility
...
Closes #148
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
fredbi
9dd26fd32b
Fixed running incorrect jsdoc command on Windows
...
Issue #125 .
jsdoc on windows is deployed as jsdoc.cmd
2018-07-12 14:53:19 -07:00
Sam Lai
974bae1f20
Support specifying package directories in autoapi_dirs ( #135 )
...
* Support specifying package directories as well
Fixes #108 .
* Use os.sep instead of the hardcoded '/'
This was making the tests fail on Windows because the necessary '/'
replacements were not happening on Windows due to os.sep being '\\'.
2018-07-03 21:34:31 -07:00
Ashley Whetter
ea6f1d322e
Fix lint errors
2018-06-05 23:15:45 -07:00
Ashley Whetter
6ca62f16c9
Can control how __init__ docstring is displayed
2018-06-05 22:47:32 -07:00
Ashley Whetter
6eb18467f7
Fixed undoc members logic
2018-06-02 10:57:45 -07:00
Ashley Whetter
9f6f7d0b5d
Added support for viewcode
2018-05-24 07:50:39 -07:00
Ashley Whetter
741dfaffb3
Source files no longer need to be in sys.path
2018-05-08 22:41:35 -07:00
Ashley Whetter
b19b9ea28b
Extended ast parsing with astroid
2018-05-08 22:41:35 -07:00
Sam Lai
ea8efe91dc
Fix lint errors
...
There should be no behavioural changes - this is just explicitly returning what would've been returned anyway.
2018-04-21 20:48:06 +01:00
Ashley Whetter
b06d4f801b
Started autoloading autosummary extension
2017-11-10 14:57:43 -08:00
Ashley Whetter
5075467441
Formats napoleon docstrings in Python
2017-11-10 13:05:35 -08: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
b5be7b6d9a
Fixed a warning
2017-11-09 12:21:52 -08:00
Ashley Whetter
958fe10103
Added autoapisummary directive
2017-11-09 12:21:52 -08:00
Ashley Whetter
5a86878811
Fixed Python subpackages having incomplete names
2017-11-09 11:54:16 -08:00
Eric Holscher
e5cce2c7dd
Fix lint
2017-11-09 10:56:42 -07:00
Eric Holscher
d803b28d00
Kill janky napolean overlay
2017-11-09 10:54:20 -07:00
Eric Holscher
3531f5560a
Merge remote-tracking branch 'origin/master' into cleanup-june
2017-11-09 10:51:24 -07:00
Ashley Whetter
86a9ffdd60
Fixed lint errors
2017-11-08 16:04:25 -08:00
Ashley Whetter
ae1e4f556d
Fixed usage of deprecated status_indicator
...
This fixes a compatibiity issue with Sphinx 1.7
2017-11-05 15:11:06 -08:00
Ashley Whetter
a1a3f05202
Fix for Sphinx 1.6
2017-11-05 14:18:43 -08:00
Eric Holscher
3875cf495d
Fix noting the toctree
2017-06-29 15:10:06 -07:00
Eric Holscher
21a82718ab
Fix linting
2017-06-29 14:48:06 -07:00
Eric Holscher
8c1016f8c7
Fix linting
2017-06-29 14:37:59 -07:00
Eric Holscher
ed57a216ec
Fix lint
2017-06-29 13:01:23 -07:00
Eric Holscher
0e3e5df437
Fix linting
2017-06-29 10:57:38 -07:00
Eric Holscher
86a4de1668
Don’t show modules with no content.
2017-06-29 10:45:54 -07:00
Eric Holscher
4428ecd6e8
Add ability to process Napolean docstrings.
2017-06-27 17:40:34 -07:00
Eric Holscher
efb541f78a
Add ability to add API to top-level TOC.
2017-06-27 17:12:47 -07:00
Eric Holscher
3233bc0ac7
Fix templates to nest functions and use short names
2017-06-27 17:12:17 -07:00
Anthony
152ea1a521
Merge pull request #104 from rtfd/python-ast
...
Start altering the pydocstyle AST parser for our needs
2017-04-07 18:06:17 -07:00
Anthony
e7a624254a
Merge pull request #106 from rtfd/fix-argument-call
...
Fix Python argument parsing for Call nodes
2017-04-07 17:55:25 -07:00
Anthony Johnson
715b6662e5
Fix Python argument parsing for Call nodes
...
This previous was throwing exceptions in some cases where Attribute nodes were
used instead of Name nodes.
2017-04-07 16:36:23 -07:00
Anthony Johnson
df74247128
Allow for toplevel module as Sphinx extension
...
Instead of requiring:
extensions = ['autoapi.extension']
This allows for the toplevel:
extensions = ['autoapi']
This is more intuitive for users, as extension is an internal concept.
2017-04-07 15:33:39 -07:00
Anthony Johnson
2603729925
Fix some more parsing issues
2017-04-07 15:25:34 -07:00
Anthony Johnson
0faeb500ee
More fixes
2017-04-07 13:12:10 -07:00
