ref: f80519b53c880e5eb8d30019fd710e8affdebcad
parent: 5399f174a309d47320b07089de6ddbd3cbf8c288
author: Paul Brossier <piem@piem.org>
date: Fri Mar 24 14:54:20 EDT 2017
doc/develop.rst: clean up
--- a/doc/develop.rst
+++ b/doc/develop.rst
@@ -3,21 +3,16 @@
Developping with aubio
======================
-Read `Contribute`_ to report issues and request new features.
+Here is a brief overview of the C library.
-See `Doxygen documentation`_ for the complete documentation of the C library,
-built using `Doxygen <http://www.doxygen.org/>`_.
+See also the `API documentation <https://aubio.org/doc/latest/>`_ for a more
+detailed list of available functions.
-Below is a brief `Library overview`_.
+To report issues, ask questions, and request new features, use `Github Issues
+<https://github.com/aubio/aubio/issues>`_
-Library overview
-----------------
-
-Here is a brief overview of the C library. See also the `Doxygen
-documentation`_ for a more detailed list of available functions.
-
Design Basics
-`````````````
+-------------
The library is written in C and is optimised for speed and portability.
@@ -42,7 +37,7 @@
Vectors and matrix
-``````````````````
+------------------
``fvec_t`` are used to hold vectors of float (``smpl_t``).
@@ -64,7 +59,8 @@
:lines: 9-19
Reading a sound file
-````````````````````
+--------------------
+
In this example, ``aubio_source`` is used to read a media file.
First, create the objects we need.
@@ -92,8 +88,8 @@
See the complete example: :download:`test-source.c
<../tests/src/io/test-source.c>`.
-Computing the spectrum
-``````````````````````
+Computing a spectrum
+--------------------
Now let's create a phase vocoder:
@@ -115,7 +111,8 @@
Doxygen documentation
---------------------
-The latest version of the doxygen documentation is available at:
+The latest version of the API documentation is built using `Doxygen
+<http://www.doxygen.org/>`_ and is available at:
https://aubio.org/doc/latest