Commit Graph

107 Commits

Author SHA1 Message Date
Ashley Whetter
86a2aeb6d7 Fixed some unicode decode errors 2019-08-25 15:53:58 -07:00
Ashley Whetter
fd1cef5ced Updated Autodoc directives for Sphinx 2.1 features
Added autoapidecorator directive.
Abides by autodoc_docstring_signature.
autoapifunction documents async functions.

Closes #166.
2019-08-10 23:08:03 -07:00
Ashley Whetter
34d02faa2f Custom argument formatting
Closes #162
2019-08-07 23:23:21 -07:00
Ashley Whetter
46c577eda1 Support for async and other Sphinx 2.1 method directive options 2019-07-17 20:59:20 -07:00
Ashley Whetter
589826e90c Can override ignoring local imports in modules by using __all__ 2019-06-23 12:36:58 -07:00
Ashley Whetter
6f4b4efef5 Corrected version to Python to skip tests for 2019-04-21 22:56:43 -07:00
Ashley Whetter
b90284f0fe Support basic type annotations
Closes #139
2019-04-21 21:58:25 -07:00
Ashley Whetter
ec091aa706 Removed some old tests 2019-04-21 15:45:06 -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
b5d83f8472 Fixed tests 2019-04-06 11:15:18 -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
Ashley Whetter
60464d0d23 Fixed formatting error 2019-02-20 07:34:10 -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
f77bf19800 Added Black formatting 2019-01-26 21:20:45 -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
2e8aab2653 Added complex integration tests 2019-01-26 16:18:16 -08:00
Ashley Whetter
88eea89bb5 Reorganised Python tests to be more pytest-like 2019-01-26 16:18:16 -08:00
Ashley Whetter
e867f0cb08 Fixed no title warning during tests 2018-11-14 22:40:33 -08:00
Ashley Whetter
aac53178eb Fixed error parsing files with unicode docstrings 2018-11-13 11:07:36 -08:00
Ashley Whetter
c3ef72ee14 Fixed nested classes not getting displayed in autogenerated docs 2018-08-07 14:39:38 -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
4ac85dd7af Added autoapi directives for Python 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
67dc008546 Added test for assignment to global containers 2018-08-01 20:13:50 -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
6ca62f16c9 Can control how __init__ docstring is displayed 2018-06-05 22:47:32 -07:00
Ashley Whetter
b19b9ea28b Extended ast parsing with astroid 2018-05-08 22:41:35 -07:00
Ashley Whetter
87baee8998 Added integration tests for napoleon conversions 2017-11-10 14:57:43 -08:00
Ashley Whetter
4adcdc5351 Python documentation is now hierarchical 2017-11-09 12:48:21 -08:00
Ashley Whetter
174e6b8232 Fixed tests under Python 3 2017-11-05 15:03:18 -08:00
Ashley Whetter
a1a3f05202 Fix for Sphinx 1.6 2017-11-05 14:18:43 -08:00
Anthony Johnson
2603729925
Fix some more parsing issues 2017-04-07 15:25:34 -07:00
Anthony Johnson
3c6e0e4015 Start altering the pydocstyle AST parser for our needs
This forks some of the pydocstyle AST parser into out mapper. Eventually, some
of the other operations such as parsing arguments and performing full name
lookup can be moved in as well. For now, this is not doing any extra assignment
tracking/etc, several of these operations will just throw this information out.

Refs #99
2017-04-07 11:46:57 -07:00
Eric Holscher
875d6b6ffa Fix tests 2016-11-04 15:47:57 -07:00
Eric Holscher
215dd06e0a Add basic test for TOC Tree insertion 2016-11-03 19:52:54 -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
b24293e545 Start using pydocstyle for Python doc generation 2016-06-09 15:44:30 -07:00
Anthony Johnson
5c07b6cbc5 Make docfx great again!
This updates some small outdated pieces with docfx integration:

* Support docfx.json first, if no patterns were explicitly specified
* Refactor output path, use new _api path
* Add missing operator type to .net parsing and template output
* Fix indent issue with code samples
* Add docs on how to actually use docfx + autoapi

Fixes #45
Fixes #46
Fixes #48
2016-06-02 17:24:31 -07:00
Anthony Johnson
20a1852907 Fix outdated fixture data 2016-03-25 18:17:05 -07:00
Anthony Johnson
019f064f36 Fix parsing issues with code comment XML
* paramref surrounding characters were not handled
* multiple paramrefs weren't parsed out
* uses correct return field

* Fixes #55
* Fixes #56
2016-02-25 11:46:56 -08:00
Anthony Johnson
d30fa32762 Add configurable url prefix 2015-10-27 11:35:44 -07:00
Anthony Johnson
1688b53f42 Replace non-existant :dn:ref: reference with :any: for now
This will resolve more lookups as proper references, not anchor links. The :any:
lookup is strict though, the domain should implement it's own :dn:obj: generic
lookup.
2015-10-27 01:12:25 -07:00
Anthony Johnson
2fd908e2a7 Fix test 2015-10-27 00:51:26 -07:00
Anthony Johnson
af5bb7daeb Fix some escaping issues with transformed XML content
Fixes #38
2015-10-27 00:46:59 -07:00
Eric Holscher
4de4b376ca Rename autoapi_dir to autoapi_dirs to support multiple 2015-09-23 16:00:43 -07:00