README.md

Build Lithops documentation

The Publish release workflow builds these docs and publishes them to the website repository on every release. To republish them without a release (e.g. after fixing them), run the Publish docs workflow from the Actions tab: it builds master and publishes it as the docs of the latest release. The steps below are for building them locally.

1. Install Lithops with Sphinx and all plugins, from the repository root:

   python3 -m pip install -e '.[docs]'

2. Install Pandoc. For debian/ubuntu:

   sudo apt install pandoc

3. Build the static HTML files:

   make html

4. The documentation HTML files are located in the _build folder. Copy them to the website repo under docs folder:

   rm -R ../../lithops-cloud.github.io/docs/*
   cp -R _build/html/* ../../lithops-cloud.github.io/docs/

5. To clean build files run:

   make clean

You can also use this Dockerfile to build the documentation using a Docker container.