File: document.rst

package info (click to toggle)
python-wsme 0.6-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 956 kB
  • ctags: 1,831
  • sloc: python: 8,452; makefile: 138
file content (43 lines) | stat: -rw-r--r-- 668 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
API Documentation test
======================

Example
~~~~~~~

.. wsme:root:: wsme.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:: wsme.sphinxext.SampleType
    :members:

.. autoservice:: wsme.sphinxext.SampleService
    :members:


.. autotype:: test_sphinxext.ASampleType
    :members:

.. autotype:: wsme.types.bytes

.. autotype:: wsme.types.text

.. _Sphinx: http://sphinx.pocoo.org/