util/docker/doc.coreboot.org/README.md

   1 # doc.coreboot.org
   2  Docker container for generating and developing documentation for doc.coreboot.org
   3
   4 **NOTE**: All paths are from the base of the coreboot git repo.
   5
   6 ### Build
   7
   8 ```sh
   9   docker build --force-rm -t "doc.coreboot.org" "$PWD/util/docker/doc.coreboot.org/"
  10 ```
  11
  12 ### Generating production HTML
  13
  14 ```sh
  15 # To ensure the output directory is given the correct permissions, make sure to
  16 # created it before running docker the first time.
  17 mkdir -p "$PWD/Documentation/_build/"
  18
  19 docker run -it --rm \
  20            --user "$(id -u):$(id -g)" \
  21            -v "$PWD/:/data-in/:ro" \
  22            -v "$PWD/Documentation/_build/:/data-out/" \
  23            doc.coreboot.org
  24 ```
  25
  26 ### live reloaded with web server
  27 On the host machine, open a browser to the address http://0.0.0.0:8000
  28 ```sh
  29 docker run -it --rm \
  30            --net=host -v "$PWD/:/data-in/:ro" \
  31            doc.coreboot.org livehtml
  32 ```