Ashley Whetter
3b52975340
Fixed unicode decoding on Python 3.7
2018-11-14 22:40:22 -08:00
Ashley Whetter
c6f34398b5
Fixed autodoc not documenting top level packages or modules
2018-11-14 22:39:18 -08:00
Ashley Whetter
aac53178eb
Fixed error parsing files with unicode docstrings
2018-11-13 11:07:36 -08:00
Ashley Whetter
66cf2ed4d0
Fixed autodoc not documenting anything in submodules or subpackages
2018-09-24 14:52:18 -07:00
Ashley Whetter
a1f1fd8651
Fixed properly resolving definitions imported more than once
2018-09-07 17:36:20 -07:00
Ashley Whetter
2799fb32cc
Fixed error when documenting something that's imported in more than one place
2018-09-07 16:56:11 -07:00
Ashley Whetter
007ef746f4
Fixed linter again
2018-08-20 11:01:07 -07:00
Ashley Whetter
fb8892ccad
Fixed lint error
2018-08-20 09:48:24 -07:00
Ashley Whetter
c3f3cc33de
Added viewcode support for imported members
2018-08-20 09:37:43 -07:00
Ashley Whetter
92b4ea9dc8
Fixed linking to builtin bases
2018-08-13 17:26:54 -07:00
Ashley Whetter
616267726b
No longer document __init__ attributes without a docstring
...
Fixes #146
Also fixed duplicates when a property is set in __init__.
2018-08-13 14:22:11 -07:00
Ashley Whetter
8d4fb4b1c3
Can document a public python API
...
Closes #153
2018-08-13 12:18:56 -07:00
Ashley Whetter
9e9c28e15b
Can opt to write manual documentation
2018-08-10 09:00:54 -07:00
Ashley Whetter
b789dcaa73
Fixed autodoc being unable to discover nested classes
2018-08-07 14:39:38 -07:00
Ashley Whetter
c3ef72ee14
Fixed nested classes not getting displayed in autogenerated docs
2018-08-07 14:39:38 -07:00
Ashley Whetter
8a965bb15a
Fixed lint error
2018-08-07 14:33:42 -07:00
Ashley Whetter
bc65e766c3
Made it easier to remove default index page
...
Also removed autoapi_add_api_root_toctree config option
because it is less useful now.
Closes #152
2018-08-06 16:23:33 -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
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
