gekl / sphinx_builder

Sphinx-autobuild image

That is images which is usefull to develop documentation online.

Usage

Create empty template

To create an empty template you could use the following command:

docker run -it --rm -v $(pwd):/spec -u $(id -u ${USER}):$(id -g ${USER})  ci.arenadata.io/sphinx-autobuild /script/create_tmpl.sh

Run autobuild develop server

Run docker container against your documentation:

docker run -it --rm -v $(pwd)/spec:/spec -p 9000:9000 ci.arenadata.io/sphinx-autobuild:latest

Open browser on http://127.0.0.1:9000. Edit your rst files, whatch for changes online.

To stop container just hit ctrl-c

Helper function

It is nice to make a helper function for you to run in one command. Place the following to your ~/.bashrc

function hlp_sphinx_autobuild(){
    docker run -it --rm -v $(pwd)/spec:/spec -p 9000:9000 ci.arenadata.io/sphinx-autobuild:latest
}

Speedup

If you whant to speed docs building you could use your own dir for temporary html generation instead of container one.

Do the following:

docker run -it --rm -v $(pwd)/spec:/spec -v /tmp/html:/html -p 9000:9000 ci.arenadata.io/sphinx-autobuild:latest

You could also use tmpfs for that.

Build image

docker build -t ci.arenadata.io/sphinx-autobuild:latest