Mooncake/docs

Mooncake documents

Build the docs

• Make sure in docs directory

cd docs

• Install the dependencies:

pip install -r ../requirements_docs.txt

• Clean the previous build (optional but recommended):

make clean

• Generate the HTML documentation:

make html

Be sure to set locale right before building.

Open the docs with your browser

• Serve the documentation locally:

python -m http.server -d build/html/

This will start a local server at http://localhost:8000. You can now open your browser and view the documentation.

If port 8000 is already in use, you can specify a different port, for example:

python -m http.server 3000 -d build/html/