Scio includes a Sphinx extension, scio.autowsdl, that you can use to automatically document SOAP services defined in wsdl files.
To use autowsdl, include it in your conf.py:
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
'sphinx.ext.intersphinx', 'scio.autowsdl']
Then in a source reST document processed by Sphinx, include a declaration like:
.. autowsdl: path/to/wsdl_file.wsdl
:namespace: stuffz
The generated documentation looks like the example below. The classes documented will be given a pseudo-module namespace to avoid collisions when generating documentation for multiple wsdl files. By default, the namespace is the basename of the wsdl file, with the file extension removed. If you want to customize the namespace, set the :namespace: option in the .. autowsdl block.
Methods are accessible under the service attribute of a client instance.
Parameters: |
|
---|---|
Return type: | lyricwiki.BooleanType |
Parameters: |
|
---|---|
Return type: | (lyricwiki.StringType, lyricwiki.StringType, lyricwiki.IntType, lyricwiki.StringType, lyricwiki.ArrayOfstring) |
Parameters: | artist – lyricwiki.StringType |
---|---|
Return type: | (lyricwiki.StringType, lyricwiki.AlbumDataArray) |
Parameters: | artist – lyricwiki.StringType |
---|---|
Return type: | (lyricwiki.StringType, lyricwiki.StringType, lyricwiki.StringType) |
Parameters: |
|
---|---|
Return type: |
Parameters: |
|
---|---|
Return type: |
Parameters: |
|
---|---|
Return type: | (lyricwiki.StringType, lyricwiki.StringType, lyricwiki.IntType, lyricwiki.BooleanType, lyricwiki.StringType) |
Parameters: |
|
---|---|
Return type: | (lyricwiki.StringType, lyricwiki.BooleanType, lyricwiki.StringType) |
Parameters: |
|
---|---|
Return type: | (lyricwiki.StringType, lyricwiki.StringType, lyricwiki.BooleanType, lyricwiki.StringType) |
Parameters: |
|
---|---|
Return type: | (lyricwiki.StringType, lyricwiki.StringType, lyricwiki.BooleanType, lyricwiki.StringType) |
Parameters: |
|
---|---|
Return type: |
Parameters: | searchString – lyricwiki.StringType |
---|---|
Return type: | lyricwiki.ArrayOfstring |
Parameters: |
|
---|---|
Return type: |
Types are accessible under the type attribute of a client instance.
type: lyricwiki.StringType
type: lyricwiki.IntType
type: lyricwiki.StringType
type: lyricwiki.ArrayOfstring
type: lyricwiki.StringType
type: lyricwiki.StringType
type: lyricwiki.IntType
type: lyricwiki.StringType
type: lyricwiki.StringType
type: lyricwiki.StringType
type: lyricwiki.StringType