Ashley Whetter
b5dfea1c6d
Removed some dead code
2019-04-21 15:40:00 -07:00
Ashley Whetter
0cee730693
Do not add a toctree entry when not generating docs
2019-04-21 15:40:00 -07:00
Ashley Whetter
3db1fd1226
Fixed error when an invalid object is given to an autodoc directive
2019-04-21 15:38:22 -07:00
Ashley Whetter
7230330686
Documentation overhaul
2019-04-21 15:38:22 -07:00
Ashley Whetter
dd58809d89
Added support for parsing stub files
...
Closes #100
2019-04-06 11:25:39 -07:00
Ashley Whetter
3b299be332
Tidied up index page
2019-04-06 10:33:38 -07:00
Ashley Whetter
8242f2ea13
Added Sphinx 2.0 support
2019-04-06 10:04:15 -07:00
Ashley Whetter
c6b46969f8
Fixed decoding of binary data on Python 2
...
Fixes #159
2019-03-30 13:43:26 -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
Alexander Gor
b94acc6019
Properly pass file patterns to godocjson utility ( #161 )
...
* Properly pass file patterns to godocjson utility
* Go integration tests fixed during to new *ignore* argument
2019-02-20 07:26:20 -08:00
Ashley Whetter
80fd76bd1e
Fixed false warning when importing a local module
2019-02-04 21:21:32 -08:00
Ashley Whetter
68e1f79ed5
Added render log messages
2019-01-30 21:53:08 -08:00
Ashley Whetter
f77bf19800
Added Black formatting
2019-01-26 21:20:45 -08:00
Ashley Whetter
c4fe76ef23
Removed references to old css and js files
2019-01-26 17:16:22 -08:00
Ashley Whetter
2cf80b1569
Fixed Sphinx logger deprecation warnings
2019-01-26 17:11:12 -08:00
Ashley Whetter
dfe82ae94e
Dropped support for Sphinx<1.6
2019-01-26 16:26:39 -08:00
Ashley Whetter
00894a959e
Overhauled Python import resolution logic
...
Stable in more complex cases.
Capable of giving more detailed warnings.
More closely matches real import logic.
Closes #156
2019-01-26 16:18:16 -08:00
Ashley Whetter
9fe8489bfe
Fixed lint errors
2019-01-26 16:18:16 -08:00
Ashley Whetter
1caa6d22e1
Fixed some import chains failing to resolve depending on resolution order
2018-11-15 13:31:33 -08:00
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
