Ashley Whetter
2e875f81c3
Updated tests for latest Sphinx 3.0.x fixes
2020-05-14 20:32:24 -07:00
Matthijs van der Burgh
0e7930e2e0
Fix version in docs conf.py
2020-05-14 20:00:25 -07:00
Matthijs van der Burgh
b8f1ba7cff
Update release process with added version number
2020-05-14 20:00:25 -07:00
Matthijs van der Burgh
e0b41e00a7
Add __version__ to __init__.py
2020-05-14 20:00:25 -07:00
Ashley Whetter
3eb33270c5
Version 1.3.0
2020-04-05 20:26:00 -07:00
Ashley Whetter
6bfe168abe
Updated Travis Python versions
2020-04-05 20:09:07 -07:00
Ashley Whetter
5794902b23
Support Sphinx 2.4 and 3.0
2020-04-05 20:03:05 -07:00
Ashley Whetter
3c4f0b7fe6
Tests are included in the sdist
2020-04-05 20:00:18 -07:00
Ashley Whetter
0d95377bbf
Accept template directory relative to conf.py
...
Closes #184
2020-04-05 18:50:32 -07:00
Ashley Whetter
9008db48e5
Added assertion to assist with import resolution debugging
2020-04-05 18:25:07 -07:00
Ashley Whetter
c3fe9f77cb
Fixed minor changelog formatting issue
2020-02-01 13:04:31 -08:00
Ashley Whetter
428e8526f0
Fixed Python 2 support
2020-02-01 12:53:40 -08:00
Ashley Whetter
4ba45cfacb
Can document inherited members
...
Closes #183
2020-02-01 12:53:40 -08:00
Ashley Whetter
c5d5fb5346
Made passing of options to templates more sane
2020-01-25 17:36:06 -08:00
Ashley Whetter
265b4ae562
Added show-inheritance
...
Also turned autoapi_include_inheritance_graphs into a
show-inheritance-diagram AutoAPI option to be more consistent
with show-inheritance.
Partially implements #183
2020-01-25 14:38:22 -08:00
Ashley Whetter
076427e6ae
Added inheritance diagrams support
...
Close #140
2020-01-11 17:29:36 -08:00
Ashley Whetter
3747596021
Fixed formatting
2020-01-11 14:52:37 -08:00
Ashley Whetter
fc1d78f758
Python 3.8 support
2020-01-11 14:37:13 -08:00
Ashley Whetter
f8b6a6151c
arg and kwargs annotations can be read from the function type comment
2020-01-08 10:23:34 -08:00
Ashley Whetter
9c91de9370
Ignore extra argument type annotations
...
Closes #186
2020-01-07 16:23:12 -08:00
Ashley Whetter
d40122948b
Remaining rtfd -> readthedocs replacements
2020-01-03 12:12:04 -08:00
Ashley Whetter
3a415e2f58
More documentation tweaks
2020-01-03 11:03:17 -08:00
Ashley Whetter
b5b2b2f08e
Make the linter happy again
2020-01-03 09:26:32 -08:00
Ashley Whetter
4bccd1bfe7
Documentation tweaks
2020-01-03 09:22:57 -08:00
Olivier Samyn
d71ac5f250
fix: Make the linter happy
2020-01-03 08:39:06 -08:00
Olivier Samyn
cca3a781ee
fix: correct stop condition in sphinx <2.0 and add a stop guard.
2020-01-03 08:39:06 -08:00
Olivier Samyn
a836795d17
doc: Add autoapi_python_use_implicit_namespaces config value description
...
+
2020-01-03 08:39:06 -08:00
Olivier Samyn
5f085ca47f
test: add implicit namespace checks
2020-01-03 08:39:06 -08:00
Olivier Samyn 🎻
7ca958fe57
feat: Support implicit namespaces for python >= 3.3
2020-01-03 08:39:06 -08:00
Ashley Whetter
4c927b2a3f
Minor fix in how_to.rst ( #185 )
2020-01-03 08:33:44 -08:00
Ashley Whetter
2af3d462bf
Fixed formatting of the table in the tutorials
2020-01-03 08:32:15 -08:00
Yuji Tabata
7cc6b72c96
Minor fix in how_to.rst
2019-12-03 13:05:03 +09:00
Ashley Whetter
daa5ce24a5
Version 1.2.1
2019-10-09 20:02:29 -07:00
Ashley Whetter
74889a9d07
"Invalid desc node" warning no longer raised for autodoc-style directives
2019-10-09 19:53:26 -07:00
Ashley Whetter
e06fa71dbc
Version 1.2.0
2019-10-05 17:01:36 -07:00
Ashley Whetter
28301f1ba4
Fix linting again
2019-10-05 17:00:05 -07:00
Ashley Whetter
520f3b0469
Fixed formatting
2019-10-05 16:09:26 -07:00
Ashley Whetter
b8fddf9c0b
Added some missing documentation
2019-10-05 16:05:37 -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
谷月轩
f6649ebde4
Include methods in child class ( #176 )
2019-10-05 12:39:50 -07:00
Ashley Whetter
900072e99b
Added documentation for optional dependencies
2019-09-07 17:25:03 -07:00
Ashley Whetter
45ff03a3ad
Disable linting for now
2019-09-07 17:03:21 -07:00
Armand BENETEAU
fa3b0b3f70
Fix Go documentation generation ( #172 )
...
* Correction of the "parameters" accessibility problem in the Go mapper
The "parameters" attributes of the GoPythonMapper class instance was
not accessible from the "output_rst" function used to create the .rst
file. Thanks to this correction, the parameters are now accessible.
* Enhance the template used to genertae the .rst file from the .go source file
This modification allows to create a .rst file compatible with the
last version of Sphinx. Without this correction, the creation of documentation
was not possible. A "make html" command lead to an "AssertionError" Exception.
2019-09-03 20:55:52 -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
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
