Public | Automated Build

Last pushed: 8 months ago
Short Description
Sphinx documentation with livereload.
Full Description

About

sphinx-autobuild

This repos is sphinx-autobuild Dockerfile.

Usage

  1. Type sphinx-quickstart or git clone your sphinx repository.
  2. cd repos
  3. docker run

Run

  • type docker run directly:

    $ docker run -it -p 8000:8000 -v $PWD:/document sshd/sphinx-autobuild sphinx-autobuild -H 0.0.0.0 -b html -d build/doctrees source build/html

  • or create shellscript and type ./autobuild:

  1. cd the document's root dir, and create following file named autobuild.

    #!/bin/bash
    docker run -it -p 8000:8000 -v $PWD:/document sshd/sphinx-autobuild sphinx-autobuild -H 0.0.0.0 -b html -d build/doctrees source build/html

  2. then run.

    $ ./autobuild

What's Sphinx?

Sphinx is documentation generator. see the official document.

Docker Pull Command
Owner
sshd