@@ -27,7 +27,8 @@ This module is not meant to be used on its own, it is only useful in cooperation
2727with another Python module using CFFI.
2828For an example, have a look at https://github.com/spatialaudio/python-rtmixer.
2929
30- You can get the Python code from PyPI _, for example in your ``setup.py `` file:
30+ You can get the Python code from PyPI _, for example in your ``setup.py `` file
31+ (in the following example, your module would be called ``mycffimodule ``):
3132
3233.. code :: python
3334
@@ -38,6 +39,7 @@ You can get the Python code from PyPI_, for example in your ``setup.py`` file:
3839 version = ... ,
3940 author = ... ,
4041 ... ,
42+ cffi_modules = [' mycffimodule_build.py:ffibuilder' ],
4143 setup_requires = [' CFFI' , ' pa_ringbuffer' ],
4244 install_requires = [' pa_ringbuffer' ],
4345 ... ,
@@ -49,7 +51,8 @@ Alternatively, you can just copy the file ``src/pa_ringbuffer.py`` to your own
4951source directory and import it from there.
5052
5153You can build your own CFFI module like described in
52- http://cffi.readthedocs.io/en/latest/cdef.html, just adding a few more bits:
54+ http://cffi.readthedocs.io/en/latest/cdef.html, just adding a few more bits to
55+ your ``mycffimodule_build.py ``:
5356
5457.. code :: python
5558
@@ -84,7 +87,8 @@ header:
8487* https://app.assembla.com/spaces/portaudio/git/source/master/include/portaudio.h
8588
8689Once you have compiled your extension module (with the help of CFFI), you can
87- use something like this to get access to the ``RingBuffer `` class:
90+ use something like this in your own module to get access to the ``RingBuffer ``
91+ class:
8892
8993.. code :: python
9094
@@ -143,9 +147,10 @@ And somewhere within your module documentation, you should add this:
143147 :inherited-members:
144148
145149 Before that, you might have to use the currentmodule _ directive to select your
146- own module.
150+ own module. Using automodule _ should also do.
147151
148152.. _Sphinx : http://www.sphinx-doc.org/
149153.. _autodoc : http://www.sphinx-doc.org/ext/autodoc.html
150154.. _currentmodule : http://www.sphinx-doc.org/domains.html
151155 #directive-py:currentmodule
156+ .. _automodule : http://www.sphinx-doc.org/ext/autodoc.html#directive-automodule
0 commit comments