pyircbot/docs/builder
dave df678c29b0 Make requirements and docbuilder simpler 2018-02-10 15:57:39 -08:00
..
Dockerfile Make requirements and docbuilder simpler 2018-02-10 15:57:39 -08:00
README.md Update docs & docbuilder 2017-03-28 16:48:31 -07:00
build-docs.sh Make requirements and docbuilder simpler 2018-02-10 15:57:39 -08:00
build.sh Make requirements and docbuilder simpler 2018-02-10 15:57:39 -08:00
start Update docs & docbuilder 2017-03-28 16:48:31 -07:00

README.md

Docs Builder

A docker image for building pyircbot's docs.

Usage:

  • Create image: cd docs/builder ; docker build -t pybdocbuilder .
  • Build docs: docker run --rm -v /local/path/to/doc/output/:/tmp/docs/ pybdocbuilder /start

Or, use a local directory instead of git master and build docs into docs/_build/html:

  • mkdir docs/_build
  • docker run -it --rm -v /localpath/to/pyircbot/repo/:/tmp/pyircbot/ pybdocbuilder