baa816c820
sphinxext tests reference paths that don't exist. this patch corrects it. Change-Id: I6a9355a53e2f72de7eab17fc117334843ff8d369
44 lines
677 B
ReStructuredText
44 lines
677 B
ReStructuredText
API Documentation test
|
|
======================
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
.. wsme:root:: wsmeext.sphinxext.SampleService
|
|
:webpath: /api
|
|
|
|
.. wsme:type:: MyType
|
|
|
|
.. wsme:attribute:: test
|
|
|
|
:type: int
|
|
|
|
.. wsme:service:: name/space/SampleService
|
|
|
|
.. wsme:function:: getType
|
|
|
|
Returns a :wsme:type:`MyType <MyType>`
|
|
|
|
|
|
.. default-domain:: wsme
|
|
|
|
.. type:: int
|
|
|
|
An integer
|
|
|
|
.. autotype:: wsmeext.sphinxext.SampleType
|
|
:members:
|
|
|
|
.. autoservice:: wsmeext.sphinxext.SampleService
|
|
:members:
|
|
|
|
|
|
.. autotype:: test_sphinxext.ASampleType
|
|
:members:
|
|
|
|
.. autotype:: wsme.types.bytes
|
|
|
|
.. autotype:: wsme.types.text
|
|
|
|
.. _Sphinx: http://sphinx.pocoo.org/
|