jaceklaskowski/sphinx-dockerd.md

## sphinx-dockerd.md

      
    Raw
  

              sphinx-dockerd.md
            
          
    Steps:

Build a Docker image and install sphinx inside
Run the image to have a complete working environment to create docs.

See https://github.com/subuser-security/subuser/blob/master/docs/Makefile.
Building jaceklaskowski/sphinx image

# Sphinx doc system containerized
#
# Heavily inspired by https://github.com/subuser-security/subuser/blob/master/docs/Makefile
FROM ubuntu:14.04.3

MAINTAINER Jacek Laskowski <jacek@japila.pl>

RUN apt-get update && apt-get install -y python-pip umlet pylint && pip install sphinx

CMD ["/bin/bash"]

Execute docker build -t jaceklaskowski/sphinx . in the directory with the Dockerfile above.
Start writing the docs

Execute docker run -ti --rm jaceklaskowski/sphinx and start writing the docs using Sphinx.
Create conf.py

conf.py = configuration file for Sphinx. Use https://github.com/subuser-security/subuser/blob/master/docs/conf.py as a reference.
Building the docs

Execute sphinx-build -b html . _build/html to generate HTML version of the docs into _build/html directory.