Commit 7e6d5f29 authored by Kristina Hoeppner's avatar Kristina Hoeppner

Corrected run command and updated instruction text

parent 6fbfe941
# Building Mahara docs # Building Mahara docs
The Mahara User Manual is: The Mahara Manual is:
- written using [reStructuredText](http://docutils.sourceforge.net/rst.html) - written using [reStructuredText](http://docutils.sourceforge.net/rst.html)
- built using [Sphinx](http://www.sphinx-doc.org/) - built using [Sphinx](http://www.sphinx-doc.org/)
- with a docker builder - with a docker builder
# Quickstart # Quickstart
Run one of the commands below to build the docs. The first command only builds english. Run one of the commands below from the main folder to build the docs.
The second builds all translations(and takes longer). The first command only builds English. The second builds all translations
(and takes longer).
``` ```
docker run -v $(pwd)/:/home/docbuilder/source mahara/docbuilder TRANSLATIONS=en html docker run -v $(pwd)/:/home/docbuilder/source mahara/docbuilder TRANSLATIONS=en html
docker run -v $(pwd)/:/home/docbuilder/source mahara/docbuilder html docker run -v $(pwd)/:/home/docbuilder/source mahara/docbuilder html
``` ```
The built docs will be in the `build/html` directory(on your host machine. The built docs will be in the `build/html` directory (on your host machine).
## Pre-requisites ## Pre-requisites
...@@ -32,7 +33,7 @@ If docker is available you can build the docbuilder image on Linux with: ...@@ -32,7 +33,7 @@ If docker is available you can build the docbuilder image on Linux with:
``` ```
cd manual-build cd manual-build
docker build --build-arg IMAGE_UID=`id -u` --build-arg IMAGE_UID=`id -g` --tag mahara/docbuilder . docker build --build-arg IMAGE_UID=`id -u` --build-arg IMAGE_GID=`id -g` --tag mahara/docbuilder .
``` ```
The `mahara/docbuilder` image is based on a debian docker image with additional The `mahara/docbuilder` image is based on a debian docker image with additional
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment