fluiddoc

Utilities to build documentations with sphinx

The documentations of the packages of the Fluiddyn project are built and hosted by Readthedocs (by the way, thank you to the readthedocs people!).

fluiddoc.on_rtd

Boolean telling whether the code is being run on readthedocs server.

fluiddoc.mock_modules(modules)[source]

Mock modules (for example for building a documentation)

Examples

mock_modules((
    'h5py', 'h5netcdf', 'pyfftw', 'theano',
    'reikna.cluda', 'reikna.fft', 'reikna.transformations'))
ipynb_maker Handle ipython notebooks (fluiddoc.ipynb_maker)
fluidnbstripout fluidnbstripout utility
fluiddocset fluiddocset utility: Generate docsets compatible with Zeal and Dash
mathmacro Sphinx extension providing a new directive mathmacro

Functions

mock_modules(modules) Mock modules (for example for building a documentation)