fluiddoc.fluiddocset

fluiddocset utility: Generate docsets compatible with Zeal and Dash

Docset is an easy to use offline documentation format. Different applications such as Zeal (Linux, Windows) and Dash (Mac OS) are available to load such docsets. Read more about generating docsets here.

fluiddoc.fluiddocset.check_sphinx_build(pkg_name, verbose, theme, regenerate=True)

Check if Sphinx docs has been built. Return path to generated html.

Parameters:

pkg_namestr

Name of a FluidDyn package.

Returns:

str, str

fluiddoc.fluiddocset.doc_to_docsets(pkg_name, verbose, archive, theme)

Convert Sphinx docs to docsets and install them.

Parameters:

pkg_namestr

Name of the Python package.

verbosebool

Verbose output messages.

archivebool

To make an archive or install locally.

Functions

check_sphinx_build(pkg_name, verbose, theme)	Check if Sphinx docs has been built.
doc_to_docsets(pkg_name, verbose, archive, theme)	Convert Sphinx docs to docsets and install them.
main()	Parse arguments and execute.