We've recently added some things to the docs repo that I wanted to talk about. The goal for this post would be to get some of you to try it and get feedback
Now there's a
Dockerfile in the repo that builds a Docker image capable of running all the Python tools we use to check and build the docs, including PDF generation. The Docker image has also a new task that detects changes on source files and rebuilds the docs automatically (only the parts that have changed) while serving them in a development HTTP server.
The README file explains in detail how to build and use this Docker image, but here's a quick start:
- Install Docker
- Build the Docker image with
docker build -t odk-docs .
- Run any task in the
./run-task.sh TASKNAME(or `.\run-task.bat TASKNAME if you're on Windows)
The new tasks that watch for changes, rebuild the docs, and serve the docs in a development server are