Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 960 Bytes

documentation.rst

File metadata and controls

39 lines (27 loc) · 960 Bytes

Documentation

The project documentation under src can be compiled using Sphinx. Output is placed in src/_build/html.

cd src
make clean html

The development container provides an installation of Python and Sphinx which can be used to build this documentation also.

Build the container as described in :ref:`dev`. Then change to the src directory that you want to compile and start the container with this directory mounted at /literacy.

sudo rkt run \
    --interactive \
    --volume literacy,kind=host,source=$(pwd) \
    dev-literacy \
    --mount volume=literacy,target=/literacy

Inside the container, change directory to /literacy and run the build command.

cd /literacy
make clean html

The compiled document is written to the shared location and is available on the host machine under src/_build/html.