5f085ca47f
test: add implicit namespace checks
5 years ago
520f3b0469
Fixed formatting
5 years ago
a122f00d4a
Fix linting
5 years ago
a114af76dc
Added autoapi-skip-member event
5 years ago
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
02b0c0a098
Made it more clear which file causes an error
5 years ago
86a2aeb6d7
Fixed some unicode decode errors
5 years ago
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
34d02faa2f
Custom argument formatting
...
Closes #162
5 years ago
46c577eda1
Support for async and other Sphinx 2.1 method directive options
5 years ago
589826e90c
Can override ignoring local imports in modules by using __all__
5 years ago
6f4b4efef5
Corrected version to Python to skip tests for
6 years ago
b90284f0fe
Support basic type annotations
...
Closes #139
6 years ago
ec091aa706
Removed some old tests
6 years ago
7230330686
Documentation overhaul
6 years ago
dd58809d89
Added support for parsing stub files
...
Closes #100
6 years ago
b5d83f8472
Fixed tests
6 years ago
c6b46969f8
Fixed decoding of binary data on Python 2
...
Fixes #159
6 years ago
a4f798183c
Fixed private submodules displaying when private-members turned off
...
Also fixed whitespace issues in templates.
6 years ago
60464d0d23
Fixed formatting error
6 years ago
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
80fd76bd1e
Fixed false warning when importing a local module
6 years ago
f77bf19800
Added Black formatting
6 years ago
dfe82ae94e
Dropped support for Sphinx<1.6
6 years ago
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
2e8aab2653
Added complex integration tests
6 years ago
88eea89bb5
Reorganised Python tests to be more pytest-like
6 years ago
e867f0cb08
Fixed no title warning during tests
6 years ago
aac53178eb
Fixed error parsing files with unicode docstrings
6 years ago
c3ef72ee14
Fixed nested classes not getting displayed in autogenerated docs
6 years ago
7dd822eef4
Can still link to public items in private modules
6 years ago
75ebcfc903
private-members also controls private subpackages and submodules
...
Closes #150
6 years ago
4ac85dd7af
Added autoapi directives for Python
6 years ago
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
67dc008546
Added test for assignment to global containers
6 years ago
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
6ca62f16c9
Can control how __init__ docstring is displayed
6 years ago
b19b9ea28b
Extended ast parsing with astroid
6 years ago
87baee8998
Added integration tests for napoleon conversions
7 years ago
4adcdc5351
Python documentation is now hierarchical
7 years ago
174e6b8232
Fixed tests under Python 3
7 years ago
a1a3f05202
Fix for Sphinx 1.6
7 years ago
2603729925
Fix some more parsing issues
8 years ago
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
875d6b6ffa
Fix tests
8 years ago
215dd06e0a
Add basic test for TOC Tree insertion
8 years ago
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
b24293e545
Start using pydocstyle for Python doc generation
8 years ago
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
20a1852907
Fix outdated fixture data
9 years ago
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
9 years ago
d30fa32762
Add configurable url prefix
9 years ago
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.
9 years ago
2fd908e2a7
Fix test
9 years ago
af5bb7daeb
Fix some escaping issues with transformed XML content
...
Fixes #38
9 years ago
4de4b376ca
Rename `autoapi_dir` to `autoapi_dirs` to support multiple
9 years ago
3a22ae63e0
Merge pull request #23 from rtfd/doc-name-slugging
...
Use more proper slugging on filenames for object
9 years ago
9dbd2f78dd
Fix os path separator
9 years ago
87a16ea421
Use more proper slugging on filenames for object
...
This resolves some issues with special characters in paths on Windows based
systems. It replaces special characters and unicode characters to ensure paths
are predictable.
9 years ago
436eb28d9f
Parse out doc id prefixes and add reference types
9 years ago
9676bd011c
Doc comment parsing and some optimizations to regex substitutions and patterns
...
Relies on regex replace and multiple replacement substitions, rather than
iterating over the pattern and applying logic to the found patterns.
Handles:
* see & seealso - creates a reference link
* paramref & typepararef - we can't reference params in sphinx, so this just
replaces with bold text
9 years ago
220599c22f
Attempt to fix path names on Windows.
9 years ago
a067576144
Embed functions inside test
9 years ago
8cd9ae16b3
Small readme update
9 years ago
d3b6bd305f
Skip epyparse tests on py3
9 years ago
acef865e6f
Fix up python 3 support.
...
This works for everything except epyparse currently.
9 years ago
2152ae373b
Add support for optionally raising error.
9 years ago
26b406fbab
Don't keep files
9 years ago
2c823fd4e8
Add proper testing config
9 years ago
49897f091c
Make sure example repo exists
9 years ago
ba632296a6
Fix .NET
9 years ago
801e2e4675
Fix mock
9 years ago
afe5190bc8
Fix README to include proper command
9 years ago
095b1e5b29
Add Indentity as the default dotnet testing project.
...
Also lots of little cleanup to remove errors on those builds.
9 years ago
d2e0bdb6f0
Still point at mvc
9 years ago
03eb110d1c
Remove outdated test deps from dotnet
9 years ago
cb28412dfd
Fix test mocks
9 years ago
136bb7c986
Small conf changes
9 years ago
30e4847898
Add basic tests & small output changes for auto-adding TOCTree
9 years ago
d0621199c8
Mock the subprocess call for .Net
9 years ago
19c79222a9
Refactor integration tests to use fixture data.
...
This removes dependence on real tooling.
The main downside is that it’s fragile to output changes in the tooling.
Not a lot we can do though,
other than have real integration tests, also.
9 years ago
e881072e84
Refactor integration tests
9 years ago
909abed977
Add basic README
9 years ago
fcfd6f258d
Add a basic example dir with clone script.
9 years ago
463816673d
Small dotnet updates
9 years ago
8770a04bf8
Update dotnet codebase for new tooling
9 years ago
685665535f
Rename files
9 years ago
1cde5590eb
Clean up how we render templates.
...
* Add top_level_object as global concept.
* Fix toctree generation
* Add passing of options to rendering
9 years ago
a3244a2531
Rename tests to be more descriptive
9 years ago
59add63ae4
Refactor DotNet Domain, and clean up tests.
9 years ago
a838e5333d
Default keep_files to off.
9 years ago
6c204dc570
Update go Domain and add basic Go test
9 years ago
2dcb0ca200
Add makefiles to all examples
9 years ago
c02cd9d32e
Add testing for template overrides.
9 years ago
5e0b1c6561
Remove old MS yaml file
9 years ago
5ca2ee76a5
Refactor into nicer top-level interface to the Domains.
...
Languages refactored:
* Python
* JS
9 years ago
819dfa92ca
Clean up gitignore and doctrees
9 years ago
bd92f55fc7
Install jsdoc globally
9 years ago
5468c580ce
Rename test dirs, and clarify naming
9 years ago
9bc6072283
Add initial javascript support with jsdoc 3.
9 years ago
Olivier Samyn
Ashley Whetter
Daniel Daniels
Alexander Gor
Ashley Whetter
Sam Lai
Anthony Johnson
Eric Holscher