Changeset 7a8a07e

Timestamp:

Aug 27, 2016, 5:23:58 PM (8 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

55027f3

Parents:

3438b42

Message:

doc/develop.rst: add some documentation about the c-api

Location:

doc

Files:

• develop.rst (added)
• index.rst (modified) (3 diffs)
• requirements.rst (modified) (2 diffs)

doc/index.rst

@@ -40 +40 @@
    cli
    python_module
+   develop
 
 Project pages
@@ -47 +48 @@
 * `aubio on github`_: https://github.com/aubio/aubio
 * `aubio on pypi`_: https://pypi.python.org/pypi/aubio
-* `API documentation`_: https://aubio.org/doc/latest/
+* `Doxygen documentation`_: https://aubio.org/doc/latest/
 * `Mailing lists`_: https://lists.aubio.org
 
@@ -53 +54 @@
 .. _aubio on github: https://github.com/aubio/aubio
 .. _aubio on pypi: https://pypi.python.org/pypi/aubio
-.. _api documentation: https://aubio.org/doc/latest/
+.. _Doxygen documentation: https://aubio.org/doc/latest/
 .. _Mailing lists: https://lists.aubio.org/
 

doc/requirements.rst

@@ -175 +175 @@
   transform
 
-With libfftw3 built in, ``aubio_fft`` will use `FFTW <http://fftw.org>`_ to
+With libfftw3 built in, ``aubio_fft`` will use `FFTW`_ to
 compute Fast Fourier Transform (FFT), allowing aubio to compute FFT on length
 that are not a power of 2.
@@ -188 +188 @@
 If the following tools are found, additional documentations are built:
 
- - `doxygen <http://doxygen.org>`_ to build the `API documentation`.
+ - `doxygen <http://doxygen.org>`_ to build the :ref:`doxygen-documentation`.
  - `txt2man <https://github.com/mvertes/txt2man>`_ to build the :ref:`manpages`