README

A documentation template for the documentation of BfS projects.

Using Sphinx: https://www.sphinx-doc.org

If you have contributions or corrections please create an Issue at:

http://github.com/OpenBfS/sphinx-docs/issues

To get started contributing:

    * install sphinx
    * read http://jacobian.org/writing/great-documentation/what-to-write/
    * edit/add some .rst files
    * run `make html` in this directory
    * run `make latexpdf` for latex and pdf output (see below)
    * run `make epub` for epub output
    * run `make man` for man pages output
    * run `make clean` to clean _build directory

PDF output depends on Latex/Tex:
    * Linux: ...coming soon...

Generate Output using a Docker Container
    * docker run --rm -v $(pwd):/docs sphinxdoc/sphinx-latexpdf make help
    * docker run --rm -v $(pwd):/docs sphinxdoc/sphinx-latexpdf make clean
    * docker run --rm -v $(pwd):/docs sphinxdoc/sphinx-latexpdf make html
    * docker run --rm -v $(pwd):/docs sphinxdoc/sphinx-latexpdf make epub
    * docker run --rm -v $(pwd):/docs sphinxdoc/sphinx-latexpdf make latexpdf
    * docker run --rm -v $(pwd):/docs sphinxdoc/sphinx-latexpdf make man