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
03f601ed41
Updated documentation
...
Closes #120
2018-08-10 09:01:21 -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
763da7170f
Cleaned up setup.py
...
Removed distutils support. It wasn't working anyway (Closes #25 ).
Removed redundant package_dir and package_data options.
Removed old testing dependencies.
Removed unnecessary wheel dependency (Closes #143 ).
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
cf08792869
Fixed Python 2 requirements
2018-08-06 14:19:12 -07:00
Ashley Whetter
67dc008546
Added test for assignment to global containers
2018-08-01 20:13:50 -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
Eric Holscher
deab25925d
Merge pull request #141 from CurtLH/patch-1
...
Include LICENSE in source
2018-06-25 17:01:54 +01:00
Curtis Hampton
e1af7bc369
Include LICENSE in source
2018-06-22 17:04:14 -04:00
Ashley Whetter
519beec0ba
Merge pull request #138 from AWhetter/class_content
...
Can control how __init__ docstring is displayed
2018-06-17 17:14:32 -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
9d239a9100
Merge pull request #137 from AWhetter/viewcode
...
Added support for viewcode
2018-05-25 09:54:28 -07:00
Ashley Whetter
9f6f7d0b5d
Added support for viewcode
2018-05-24 07:50:39 -07:00
Eric Holscher
77c71b6cb7
Merge pull request #131 from AWhetter/fix_99
...
Extended ast parsing with astroid
2018-05-17 14:48:23 -05:00
Ashley Whetter
741dfaffb3
Source files no longer need to be in sys.path
2018-05-08 22:41:35 -07:00
Ashley Whetter
11a11ce740
Added sphinx 1.7 testing
2018-05-08 22:41:35 -07:00
Ashley Whetter
b19b9ea28b
Extended ast parsing with astroid
2018-05-08 22:41:35 -07:00
David Fischer
ea3e8bd3a1
Merge pull request #136 from slai/fix_lint
...
Fix lint errors
2018-04-23 10:05:01 -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
8dea2c8b0a
Merge pull request #132 from chanadian/fix-extension-install-steps
...
Fix hidden code samples for GO/JS extensions
2018-02-14 16:49:08 -08:00
Andrew Chan
e2e359eb69
Format code samples on installation correctly
2018-02-14 14:50:54 -08:00
Eric Holscher
da611680df
Merge pull request #128 from fredbi/master
...
PR for issues #123 and #124
2017-11-13 15:02:47 -07:00
Eric Holscher
7f6b47b86d
Bump to version 0.5
2017-11-13 08:29:06 -08:00
fredbi
cf226d4907
PR for issues #123 and #124
...
PR for issues #123 and #124
2017-11-12 22:18:11 +01:00
Eric Holscher
87ab7072fb
Merge pull request #117 from AWhetter/napoleon
...
Formats napoleon docstrings in Python
2017-11-10 16:12:20 -07:00
Ashley Whetter
b06d4f801b
Started autoloading autosummary extension
2017-11-10 14:57:43 -08:00
Ashley Whetter
87baee8998
Added integration tests for napoleon conversions
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
Anthony
a71f19f7d1
Merge pull request #118 from AWhetter/basic_class_signature
...
Added basic class signature discovery
2017-11-09 16:23:58 -07:00
Ashley Whetter
7b3e6fca6d
Added basic class signature discovery
2017-11-09 14:18:11 -08:00
