Commit Graph

113 Commits (4bccd1bfe7653123939daba6a50cb734927e79cf)

Author SHA1 Message Date
Olivier Samyn 5f085ca47f test: add implicit namespace checks 5 years ago
Ashley Whetter 520f3b0469 Fixed formatting 5 years ago
Ashley Whetter a122f00d4a Fix linting 5 years ago
Daniel Daniels a114af76dc Added autoapi-skip-member event 5 years ago
danields761 be324b10bf Made dependencies of other languages optional (#171)
* Fixes #170

* Makes sphinxcontrib-golangdomain and
sphinxcontrib-dotnetdomain to be optional
packages
* Adds check that appropriate dependencies of
a specified api-type installed during the
extension initialisation
* Adds appropriate tests
5 years ago
Ashley Whetter 02b0c0a098 Made it more clear which file causes an error 5 years ago
Ashley Whetter 86a2aeb6d7 Fixed some unicode decode errors 5 years ago
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.
5 years ago
Ashley Whetter 34d02faa2f Custom argument formatting
Closes #162
5 years ago
Ashley Whetter 46c577eda1 Support for async and other Sphinx 2.1 method directive options 5 years ago
Ashley Whetter 589826e90c Can override ignoring local imports in modules by using __all__ 5 years ago
Ashley Whetter 6f4b4efef5 Corrected version to Python to skip tests for 5 years ago
Ashley Whetter b90284f0fe Support basic type annotations
Closes #139
5 years ago
Ashley Whetter ec091aa706 Removed some old tests 5 years ago
Ashley Whetter 7230330686 Documentation overhaul 5 years ago
Ashley Whetter dd58809d89 Added support for parsing stub files
Closes #100
6 years ago
Ashley Whetter b5d83f8472 Fixed tests 6 years ago
Ashley Whetter c6b46969f8 Fixed decoding of binary data on Python 2
Fixes #159
6 years ago
Ashley Whetter a4f798183c Fixed private submodules displaying when private-members turned off
Also fixed whitespace issues in templates.
6 years ago
Ashley Whetter 60464d0d23 Fixed formatting error 6 years ago
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
6 years ago
Ashley Whetter 80fd76bd1e Fixed false warning when importing a local module 6 years ago
Ashley Whetter f77bf19800 Added Black formatting 6 years ago
Ashley Whetter dfe82ae94e Dropped support for Sphinx<1.6 6 years ago
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
6 years ago
Ashley Whetter 2e8aab2653 Added complex integration tests 6 years ago
Ashley Whetter 88eea89bb5 Reorganised Python tests to be more pytest-like 6 years ago
Ashley Whetter e867f0cb08 Fixed no title warning during tests 6 years ago
Ashley Whetter aac53178eb Fixed error parsing files with unicode docstrings 6 years ago
Ashley Whetter c3ef72ee14 Fixed nested classes not getting displayed in autogenerated docs 6 years ago
Ashley Whetter 7dd822eef4 Can still link to public items in private modules 6 years ago
Ashley Whetter 75ebcfc903 private-members also controls private subpackages and submodules
Closes #150
6 years ago
Ashley Whetter 4ac85dd7af Added autoapi directives for Python 6 years ago
Ashley Whetter 9cb2f7d50e Methods include self in their arguments
autodoc does this by default so it makes sense to do it in autoapi also.
6 years ago
Ashley Whetter 67dc008546 Added test for assignment to global containers 6 years ago
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 '\\'.
6 years ago
Ashley Whetter 6ca62f16c9 Can control how __init__ docstring is displayed 6 years ago
Ashley Whetter b19b9ea28b Extended ast parsing with astroid 6 years ago
Ashley Whetter 87baee8998 Added integration tests for napoleon conversions 7 years ago
Ashley Whetter 4adcdc5351 Python documentation is now hierarchical 7 years ago
Ashley Whetter 174e6b8232 Fixed tests under Python 3 7 years ago
Ashley Whetter a1a3f05202 Fix for Sphinx 1.6 7 years ago
Anthony Johnson 2603729925
Fix some more parsing issues 8 years ago
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
8 years ago
Eric Holscher 875d6b6ffa Fix tests 8 years ago
Eric Holscher 215dd06e0a Add basic test for TOC Tree insertion 8 years ago
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
8 years ago
Eric Holscher b24293e545 Start using pydocstyle for Python doc generation 8 years ago
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
8 years ago
Anthony Johnson 20a1852907 Fix outdated fixture data 9 years ago