Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
7
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
user-manual
manual-build
Commits
7e6d5f29
Commit
7e6d5f29
authored
Mar 03, 2020
by
Kristina Hoeppner
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Corrected run command and updated instruction text
parent
6fbfe941
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
6 deletions
+7
-6
README.md
README.md
+7
-6
No files found.
README.md
View file @
7e6d5f29
# Building Mahara docs
The Mahara
User
Manual is:
The Mahara Manual is:
-
written using
[
reStructuredText
](
http://docutils.sourceforge.net/rst.html
)
-
built using
[
Sphinx
](
http://www.sphinx-doc.org/
)
-
with a docker builder
-
with a docker builder
# Quickstart
Run one of the commands below to build the docs. The first command only builds english.
The second builds all translations(and takes longer).
Run one of the commands below from the main folder to build the docs.
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 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
...
...
@@ -32,7 +33,7 @@ If docker is available you can build the docbuilder image on Linux with:
```
cd manual-build
docker build --build-arg IMAGE_UID=`id -u` --build-arg IMAGE_
U
ID=`id -g` --tag mahara/docbuilder .
docker build --build-arg IMAGE_UID=`id -u` --build-arg IMAGE_
G
ID=`id -g` --tag mahara/docbuilder .
```
The
`mahara/docbuilder`
image is based on a debian docker image with additional
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment