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
Eric Holscher
a5d369aea4
Change rtfd -> readthedocs
2019-07-15 10:09:05 -07:00
Martín Gaitán
6b6aae95fc
fix typo on subsection's title ( #167 )
2019-07-02 16:18:08 -07:00
Ashley Whetter
0b947a028e
v1.1.0
2019-06-23 13:43:28 -07:00
Ashley Whetter
6629e0b10f
Update appveyor to Python 3.7
2019-06-23 13:30:17 -07:00
Ashley Whetter
9fc96f2ddf
Added support for Sphinx 2.1
2019-06-23 13:25:25 -07:00
Ashley Whetter
589826e90c
Can override ignoring local imports in modules by using __all__
2019-06-23 12:36:58 -07:00
Ashley Whetter
9d45eed4d0
Fixed incorrect formatting of functions and methods
2019-06-23 11:55:15 -07:00
Ashley Whetter
6d39780ae4
Fixed tox setup
2019-06-23 11:55:15 -07:00
Ashley Whetter
f3ab2ef6e2
Fixed some dead links in the README
2019-05-03 09:42:39 -07:00
Ashley Whetter
9735f43a8d
v1.0.0
2019-04-24 15:04:37 -07:00
Ashley Whetter
2084f695bd
Can set an empty function signature in autodoc directives
2019-04-21 23:01:46 -07:00
Ashley Whetter
6f4b4efef5
Corrected version to Python to skip tests for
2019-04-21 22:56:43 -07:00
Ashley Whetter
cac774c072
Added type annotation support to autodoc directives
2019-04-21 22:45:29 -07:00
Ashley Whetter
b90284f0fe
Support basic type annotations
...
Closes #139
2019-04-21 21:58:25 -07:00
Ashley Whetter
43250fbf99
Fixed another typo
2019-04-21 15:50:58 -07:00
Ashley Whetter
0d3a328a35
Fixed typo in README
2019-04-21 15:50:10 -07:00
Ashley Whetter
ec091aa706
Removed some old tests
2019-04-21 15:45:06 -07:00
Ashley Whetter
b5dfea1c6d
Removed some dead code
2019-04-21 15:40:00 -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
3db1fd1226
Fixed error when an invalid object is given to an autodoc directive
2019-04-21 15:38:22 -07:00
Ashley Whetter
7230330686
Documentation overhaul
2019-04-21 15:38:22 -07:00
Ashley Whetter
dd58809d89
Added support for parsing stub files
...
Closes #100
2019-04-06 11:25:39 -07:00
Ashley Whetter
b5d83f8472
Fixed tests
2019-04-06 11:15:18 -07:00
Ashley Whetter
3b299be332
Tidied up index page
2019-04-06 10:33:38 -07:00
Ashley Whetter
8242f2ea13
Added Sphinx 2.0 support
2019-04-06 10:04:15 -07:00
Ashley Whetter
c6b46969f8
Fixed decoding of binary data on Python 2
...
Fixes #159
2019-03-30 13:43:26 -07:00
Ashley Whetter
6dfd2378ef
Fixed typo in travis config
2019-03-30 11:50:45 -07:00
Ashley Whetter
e768a02818
Added missing environments to travis config
2019-03-30 11:49:23 -07:00
Ashley Whetter
bcf82f538c
Update travis configuration
2019-03-30 11:47:28 -07:00
Ashley Whetter
5d648c6fa8
Stopped pinning black version
2019-03-30 11:47:11 -07:00
Ashley Whetter
8ce44b2eb2
Turn off style linting
...
We have black for that now.
2019-03-05 22:52:13 -08:00
Ashley Whetter
a4f798183c
Fixed private submodules displaying when private-members turned off
...
Also fixed whitespace issues in templates.
2019-03-05 22:52:13 -08:00
Ashley Whetter
60464d0d23
Fixed formatting error
2019-02-20 07:34:10 -08:00
Ashley Whetter
d4ab0ea0a7
Start checking black on travis
2019-02-20 07:29:10 -08:00
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
2019-02-20 07:26:20 -08:00
Ashley Whetter
3722490c36
v0.7.1
2019-02-04 21:24:18 -08:00
Ashley Whetter
80fd76bd1e
Fixed false warning when importing a local module
2019-02-04 21:21:32 -08:00
Ashley Whetter
30a620e449
v0.7.0
2019-01-30 21:57:13 -08:00
Ashley Whetter
68e1f79ed5
Added render log messages
2019-01-30 21:53:08 -08:00
Ashley Whetter
63bbe719c6
Tweaked README formatting
2019-01-26 21:23:21 -08:00
Ashley Whetter
f77bf19800
Added Black formatting
2019-01-26 21:20:45 -08:00
