7ca958fe57
feat: Support implicit namespaces for python >= 3.3
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
0cee730693
Do not add a toctree entry when not generating docs
5 years ago
f77bf19800
Added Black formatting
6 years ago
c4fe76ef23
Removed references to old css and js files
6 years ago
2cf80b1569
Fixed Sphinx logger deprecation warnings
6 years ago
aac53178eb
Fixed error parsing files with unicode docstrings
6 years ago
c3f3cc33de
Added viewcode support for imported members
6 years ago
8d4fb4b1c3
Can document a public python API
...
Closes #153
6 years ago
9e9c28e15b
Can opt to write manual documentation
6 years ago
8a965bb15a
Fixed lint error
6 years ago
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
6 years ago
4ac85dd7af
Added autoapi directives for Python
6 years ago
6ca62f16c9
Can control how __init__ docstring is displayed
6 years ago
9f6f7d0b5d
Added support for viewcode
6 years ago
b06d4f801b
Started autoloading autosummary extension
7 years ago
b792463cc9
Can turn off autoapisummary directives in output
7 years ago
b5be7b6d9a
Fixed a warning
7 years ago
958fe10103
Added autoapisummary directive
7 years ago
3531f5560a
Merge remote-tracking branch 'origin/master' into cleanup-june
7 years ago
a1a3f05202
Fix for Sphinx 1.6
7 years ago
3875cf495d
Fix noting the toctree
7 years ago
efb541f78a
Add ability to add API to top-level TOC.
7 years ago
426d677324
Fix review feedback
8 years ago
d7e8e13613
Don't use string
8 years ago
6024223d9e
Add fix to version checking on <1.5
8 years ago
a9521553d9
Fix for Sphinx 1.5
8 years ago
c557182525
Fix review feedback
8 years ago
73324fab7e
Remove unneeded index entry
8 years ago
624eeff030
Break out toctree into separate file.
...
Also add lots of docstrings,
so hopefully someone can understand this some day.
8 years ago
cc41787b58
Write up a more descriptive docstring
8 years ago
b6dc3d23d8
Clean up auto-tocing
8 years ago
4eefb01759
Build initial toctree implementation
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
6025db45a7
Clean up how we handle file suffix.
8 years ago
fab86cbc66
Revert basestring -> str in check for autoapi_dirs
...
Not sure we need to be concerned about byte strings here either way.
Fixes #74
8 years ago
11ad556d3e
Handle string input for api dir
...
This was iterating over the settings assuming it was a list. We handle this as a
list in some instances, and recommend using a string in others. Just handle
both.
9 years ago
ca3a002aa6
Update extension.py to handle absolute paths
9 years ago
bcee7eb22a
Use autoapi_root for url root configuration
9 years ago
d30fa32762
Add configurable url prefix
9 years ago
3dfd9ac47f
Fix error
9 years ago
81d4568713
Merge pull request #35 from rtfd/support-multiple-source-dirs
...
Rename `autoapi_dir` to `autoapi_dirs` to support multiple source dirs
9 years ago
2958bc34fb
Fix linting errors
9 years ago
4de4b376ca
Rename `autoapi_dir` to `autoapi_dirs` to support multiple
9 years ago
Olivier Samyn 🎻
Ashley Whetter
Daniel Daniels
Ashley Whetter
Eric Holscher
Anthony Johnson
Daniel Roth