This directory holds the documentation of openSMILE in reStructuredText format. It can be used with Sphinx to build an HTML and/or PDF version of the openSMILE documentation.

Before generating the documentation, you need to install the required Python packages. The best way to do this is in a virtual environment and using pip:

virtualenv \
    --python="/usr/bin/python3" \
    --no-site-packages \
    "${HOME}/.envs/opensmile-doc"
source "${HOME}/.envs/opensmile-doc/bin/activate"
pip install -r requirements.txt.lock

You can use the Makefile to generate the documentation:

# Clean up
make clean
# Build HTML documentation under _build/html/
make html
# Build PDF documentation under _build/latex/
make latexpdf

Or alternatively directly type in the commands:

# Clean up
rm -rf _build
# Build HTML documentation under _build/html/
sphinx-build -b html -d ./_build/doctrees . ./_build/html/
# Build PDF documentation under _build/latex/
sphinx-build -b latex -d ./_build/doctrees . ./_build/latex/
make -C _build/latex all-pdf

To include openSMILE component documentation in the documentation, perform the following steps:

1. Build openSMILE. Note: the build flags you set determine which components get included in your build. The documentation you generate in the next step will only contain documentation on the components that were included in the build.

2. Export openSMILE component help in JSON format by running:

   SMILExtract -exportHelp > help.json

3. Generate Sphinx component help by running:

   python generate-components.py help.json

There should now be a components.txt file and a _components folder with the generated documentation sources. Run make html or make latexpdf as described in the previous section to generate the full documentation.