Olivier Samyn 🎻
7ca958fe57
feat: Support implicit namespaces for python >= 3.3
2020-01-03 08:39:06 -08:00
Ashley Whetter
520f3b0469
Fixed formatting
2019-10-05 16:09:26 -07:00
Ashley Whetter
a122f00d4a
Fix linting
2019-10-05 16:05:37 -07:00
Daniel Daniels
a114af76dc
Added autoapi-skip-member event
2019-10-05 13:55:18 -07:00
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
2019-09-01 14:44:17 -07:00
Ashley Whetter
02b0c0a098
Made it more clear which file causes an error
2019-08-25 17:04:30 -07:00
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
0cee730693
Do not add a toctree entry when not generating docs
2019-04-21 15:40:00 -07: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
aac53178eb
Fixed error parsing files with unicode docstrings
2018-11-13 11:07:36 -08:00
Ashley Whetter
c3f3cc33de
Added viewcode support for imported members
2018-08-20 09:37:43 -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
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
4ac85dd7af
Added autoapi directives for Python
2018-08-06 14:19:12 -07:00
Ashley Whetter
6ca62f16c9
Can control how __init__ docstring is displayed
2018-06-05 22:47:32 -07:00
Ashley Whetter
9f6f7d0b5d
Added support for viewcode
2018-05-24 07:50:39 -07:00
Ashley Whetter
b06d4f801b
Started autoloading autosummary extension
2017-11-10 14:57:43 -08:00
Ashley Whetter
b792463cc9
Can turn off autoapisummary directives in output
2017-11-09 12:48:21 -08:00
Ashley Whetter
b5be7b6d9a
Fixed a warning
2017-11-09 12:21:52 -08:00
Ashley Whetter
958fe10103
Added autoapisummary directive
2017-11-09 12:21:52 -08:00
Eric Holscher
3531f5560a
Merge remote-tracking branch 'origin/master' into cleanup-june
2017-11-09 10:51:24 -07:00
Ashley Whetter
a1a3f05202
Fix for Sphinx 1.6
2017-11-05 14:18:43 -08:00
Eric Holscher
3875cf495d
Fix noting the toctree
2017-06-29 15:10:06 -07:00
Eric Holscher
efb541f78a
Add ability to add API to top-level TOC.
2017-06-27 17:12:47 -07:00
Eric Holscher
426d677324
Fix review feedback
2017-03-02 14:18:39 -08:00
Eric Holscher
d7e8e13613
Don't use string
2017-02-08 10:12:52 -05:00
Eric Holscher
6024223d9e
Add fix to version checking on <1.5
2017-02-08 09:53:19 -05:00
Ashley Whetter
a9521553d9
Fix for Sphinx 1.5
2017-02-01 17:14:32 -08:00
Eric Holscher
c557182525
Fix review feedback
2016-11-04 13:42:15 -07:00
Eric Holscher
73324fab7e
Remove unneeded index entry
2016-11-03 13:24:22 -07:00
Eric Holscher
624eeff030
Break out toctree into separate file.
...
Also add lots of docstrings,
so hopefully someone can understand this some day.
2016-11-03 13:13:36 -07:00
Eric Holscher
cc41787b58
Write up a more descriptive docstring
2016-11-03 13:13:36 -07:00
Eric Holscher
b6dc3d23d8
Clean up auto-tocing
2016-11-03 13:13:36 -07:00
Eric Holscher
4eefb01759
Build initial toctree implementation
2016-11-03 13:13:36 -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
6025db45a7
Clean up how we handle file suffix.
2016-08-25 10:58:06 -07:00
Anthony Johnson
fab86cbc66
Revert basestring -> str in check for autoapi_dirs
...
Not sure we need to be concerned about byte strings here either way.
Fixes #74
2016-06-08 16:36:11 -07:00
Anthony Johnson
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.
2016-05-01 19:23:05 -07:00
Daniel Roth
ca3a002aa6
Update extension.py to handle absolute paths
2016-02-02 21:14:28 -08:00
Anthony Johnson
bcee7eb22a
Use autoapi_root for url root configuration
2015-10-28 11:04:23 -07:00
Anthony Johnson
d30fa32762
Add configurable url prefix
2015-10-27 11:35:44 -07:00
Eric Holscher
3dfd9ac47f
Fix error
2015-10-12 10:50:46 -07:00
Eric Holscher
81d4568713
Merge pull request #35 from rtfd/support-multiple-source-dirs
...
Rename `autoapi_dir` to `autoapi_dirs` to support multiple source dirs
2015-10-09 17:10:26 -07:00
Eric Holscher
2958bc34fb
Fix linting errors
2015-09-23 16:04:45 -07:00
Eric Holscher
4de4b376ca
Rename autoapi_dir to autoapi_dirs to support multiple
2015-09-23 16:00:43 -07:00
