2 ------------------------
4 This docker container is used for building OPNFV docs from **rst** format files for each feature
5 project. The output is just like contents in [opnfvdocs](http://docs.opnfv.org/) website. You can
6 review the contents through web browser. Currently *PDF* output is not good enough and it will make
7 the container image size 3x larger. PDF output format is not supported in this release.
11 * The default build is *html*, you can run:
13 docker run -it --rm -v ./some-opnfv-repo:/docs -v /tmp/output:/output \
17 * Then if you want to build epub, etc you could pass it as an arg:
19 docker run -it --rm -v ./some-opnfv-repo:/docs -v /tmp/output:/output \
20 -e build=epub opnfv/opnfvdocs
24 * build: [html | singlehtml | epub]
26 ## two directory parameters
27 * /docs: **mandatory**, used for source files
28 * /output: **optional**, used for storing the built result