Skip to content

GitLab

Commit 1857fd2d authored by Glenn Walbran's avatar Glenn Walbran
Browse files
Options

Populate with build/themes

parents
Hide whitespace changes
Inline Side-by-side
Showing with 1426 additions and 0 deletions
Makefile 0 → 100644
View file @ 1857fd2d
# Makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
MAHARA =
TRANSLATIONS = en de fr nl
# TRANSLATIONS_UNSUPPORTED = ja
# TODO: Building Japanese language PDFs with LaTeX is non-trivial and poorly documented.
# TODO: Complicating it with Sphinx has made it pretty much impossible. Good luck!
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean update html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
-rm -rf source/locales/*
# This is used by the build cronjob to checkout the correct manual version.
update:
git checkout .
git checkout $(MAHARA)_STABLE
git pull
fetchtranslations:
/bin/bash generate-mo-files.sh $(MAHARA)
#Delete translated images submodule, then init/update it from remote
-rm -rf source/images-translated
#Update/init/remote to effective clone from HEAD
-git submodule update --init --remote source/images-translated
preview:
$(SPHINXBUILD) -a -D language=en -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html/en/$(MAHARA)
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/en/$(MAHARA)."
html: fetchtranslations
@$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(TRANSLATION)/$(MAHARA); \
echo "---------------"; \
)
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/<language>/$(MAHARA)."
dirhtml:
$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml/$(TRANSLATION)/$(MAHARA) \
;)
@echo
@echo "Build finished. The dirhtml pages are in $(BUILDDIR)/dirhtml/<language>/$(MAHARA)."
singlehtml:
$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml/$(TRANSLATION)/$(MAHARA) \
;)
@echo
@echo "Build finished. The singlehtml pages are in $(BUILDDIR)/singlehtml/<language>/$(MAHARA)."
pickle:
$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle/$(TRANSLATION)/$(MAHARA) \
;)
@echo
@echo "Build finished. The pickle pages are in $(BUILDDIR)/pickle/<language>/$(MAHARA)."
json:
$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json/$(TRANSLATION)/$(MAHARA) \
;)
@echo
@echo "Build finished. The json pages are in $(BUILDDIR)/json/<language>/$(MAHARA)."
htmlhelp:
$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp/$(TRANSLATION)/$(MAHARA) \
;)
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp/<language>/$(MAHARA)."
qthelp:
$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp/$(TRANSLATION)/$(MAHARA) \
;)
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp/<language>/$(MAHARA), like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Mahara.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/<language>/$(MAHARA)/Mahara.qhc"
devhelp:
$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp/$(TRANSLATION)/$(MAHARA) \
;)
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Mahara"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Mahara"
@echo "# devhelp"
epub: fetchtranslations
@$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub/$(TRANSLATION)/$(MAHARA); \
cp $(BUILDDIR)/epub/$(TRANSLATION)/$(MAHARA)/Mahara.epub $(BUILDDIR)/html/$(TRANSLATION)/$(MAHARA)/Mahara.epub; \
rm -r $(BUILDDIR)/epub/$(TRANSLATION)/$(MAHARA)/; \
echo "---------------"; \
)
@echo
@echo "Build finished. The epub files have been moved to $(BUILDDIR)/html/<language>/$(MAHARA)/Mahara.epub."
latex: fetchtranslations
@$(foreach TRANSLATION,$(TRANSLATIONS), \
echo "Translation [$(TRANSLATION)]..."; \
sphinxlang=$(TRANSLATION) $(SPHINXBUILD) -a -D language=$(TRANSLATION) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex/$(TRANSLATION)/$(MAHARA); \
echo "---------------"; \
)
@echo
@echo "Build finished. The latex pages are in $(BUILDDIR)/latex/<language>/$(MAHARA)."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf: latex
@$(foreach TRANSLATION,$(TRANSLATIONS), \
echo "Translation [$(TRANSLATION)]..."; \
sed -i s/,dvipdfmx// $(BUILDDIR)/latex/$(TRANSLATION)/$(MAHARA)/Mahara.tex; \
$(MAKE) PDFLATEX="xelatex -halt-on-error -file-line-error" -C $(BUILDDIR)/latex/$(TRANSLATION)/$(MAHARA) all-pdf|grep -P -A2 ":[0-9]+:\ .*|Error:"; \
cp $(BUILDDIR)/latex/$(TRANSLATION)/$(MAHARA)/Mahara.pdf $(BUILDDIR)/html/$(TRANSLATION)/$(MAHARA)/Mahara.pdf; \
echo "---------------"; \
)
@echo
@echo "Build finished. The PDF files are in $(BUILDDIR)/latex/<language>/$(MAHARA)."
@echo " NOTE: Japanese language PDF, if built, probably failed. This is expected for now."
text:
$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text/$(TRANSLATION)/$(MAHARA) \
;)
@echo
@echo "Build finished. The text pages are in $(BUILDDIR)/text/<language>/$(MAHARA)."
man:
$(foreach TRANSLATION,$(TRANSLATIONS), \
$(SPHINXBUILD) -a -D language=$(TRANSLATION) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man/$(TRANSLATION)/$(MAHARA) \
;)
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man/<language>/$(MAHARA)."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
README.md 0 → 100644
View file @ 1857fd2d
The Mahara User Manual is written using [reStructuredText](http://docutils.sourceforge.net/rst.html)
and built using [Sphinx](http://www.sphinx-doc.org/).
Contributing to and building the documentation
==============================================
To get started, use a Python virtual environment to install the stuff in `requirements.txt`.
You'll also need a fairly recent distribution of TeX Live in order to render PDFs properly.
Ubuntu 16.04 ships with TeX Live 2015 which includes XeTeX, which handles Unicode and
OpenType fonts properly, and the language metrics (hyphenation etc.) that Sphinx uses to
build translations.
apt-get install python-virtualenv texlive-xetex texlive-lang-all texlive-fonts-extra
Clone this git repository, and in its directory, start the environemnt and install the
requirements:
virtualenv venv
. venv/bin/activate
pip install -r requirements.txt
Then you can build the documentation with the make command:
make html latexpdf
Have a look at the
[Hitchhiker's Guide to Python](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
tutorial for more information about how to use Python virtual environments; Don't panic,
it's easy!
Deploying to a server that can't install remote packages
========================================================
To do this, make a wheelhouse (a directory of pre-compiled Python packages) and copy it over
to your server, then on the server tell pip (in the virtual environment) to install them.
For instance, on your workstation:
pip wheel -w /tmp/wheelhouse -r requirements.txt
rsync -avz /tmp/wheelhouse my.server.com:/tmp/
And on the server:
cd /wherever/your/manual/is/installed
. venv/bin/activate
pip install --no-index --find-links=/tmp/wheelhouse
convert_images_dpi.sh 0 → 100755
View file @ 1857fd2d
#!/bin/bash
types=(jpg jpeg gif png);
for image in `find source/images -type f -exec echo "{}" \;`; do
if [[ ${types[@]} =~ ${image#*.} ]]
then
convert $image -strip $image
convert $image -density 110 -units PixelsPerInch $image
fi
done
generate-mo-files.sh 0 → 100755
View file @ 1857fd2d
#!/bin/bash
dir=$(dirname $0)
cd $dir
if ! which git >/dev/null; then
echo "Please install git before continuing."
exit 1
fi
if [ -z $1 ]; then
branch=$(git symbolic-ref HEAD|sed "s/refs\/heads\///")
echo "Mahara version not specified; determining from user-manual git branch: $branch"
version=$(echo $branch|sed "s/_.*//")
# Could do with a better test here, but for now this works:
if [ ! "$(echo $version|grep ^1)" = "$version" ]; then
echo "Failed to find a version."
exit 1
fi
echo "Obtained version: $version"
else
version=$1
fi
if which bzr >/dev/null; then
echo "Starting import of translations..."
else
echo "Please install bzr before continuing."
exit 1
fi
if [ ! -d launchpad ]; then
echo "Checking out the launchpad .po files"
bzr checkout lp:~mahara-lang/mahara-manual/${version}_STABLE-export launchpad || exit 1
elif [ -z $(find launchpad/.bzr/checkout/lock -type d -mmin 120 |head -1) ]; then
# Re-fetch from Launchpad if more than eight hours old, so that it
# skips during a dev or testing session, but a daily cron always fetches.
echo "Updating .po collection from launchpad"
cd launchpad
bzr switch --force ${version}_STABLE-export
cd ..
fi
#echo "Cleaning up from last time"
#rm -r source/locales # msgfmt will do merging otherwise
if [ $(ls launchpad/potfiles/ -1A | wc -l) -gt 0 ]; then
for dir in launchpad/potfiles/*; do
echo "Creating $dir .mo files"
for file in $dir/*; do
mofile="$(basename $file | sed s%.po$%%)/LC_MESSAGES$(echo $dir | sed s%launchpad/potfiles%%).mo"
mkdir -p "source/locales/$(basename $file | sed s%.po$%%)/LC_MESSAGES"
msgfmt "$dir/$(basename $file)" -o "source/locales/$mofile"
done
done
fi
#We always exit with success so that failing to fetch translations does not prevent
#the english(default) doc build
exit 0
source/conf-common.py 0 → 100644
View file @ 1857fd2d
# -*- coding: utf-8 -*-
#
# Mahara documentation build configuration file, created by
# sphinx-quickstart on Tue Nov 15 17:04:37 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
from __future__ import unicode_literals
import sys, os
html_context = {
#mahara_releases is used to build the user manual links
'mahara_releases': ['17.04', '16.10', '16.04', '15.10', '15.04', '1.10', '1.9', '1.8', '1.7', '1.6', '1.5', '1.4']
}
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.6.2'
gettext_additional_targets = ['image', 'figure']
# NOTE:
# This image translation only works for images/figures that are specified as
# [<filepath>/]<filename>.*
#
# That is you cannot specify the file extension for image translations to work.
#
# This is because of an oddity in the Sphinx asset collection. Hopefully this
# will change in the future.
figure_language_filename = "/images-translated/{language}{root}{ext}"
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinxjp.themes.basicstrap']
# Add support for showing ToDo list for the whole documentation.
todo_include_todos = False
# Add any paths that contain templates here, relative to this directory.
#templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'Mahara'
copyright = "{} Catalyst IT and others".format(copyright_years)
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
#version = '17.04'
# The full version, including alpha/beta/rc tags.
#release = '17.04'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'mahara'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = ['.']
import sphinxjp.themes.basicstrap as basicstrap
html_theme_path = ['.', basicstrap.template_path]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = "Mahara {} user manual".format(release)
# A shorter title for the navigation bar. Default is the same as html_title.
html_short_title = "" # Left blank because a background image is placed in the css with text
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
#html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
html_sidebars = {'**':['localtoc.html', 'relations.html', 'searchbox.html', 'links.html', 'translations.html']}
# html_sidebars = {'**':['localtoc.html', 'relations.html', 'searchbox.html', 'translations.html']}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'Maharadoc'
# -- Options for LaTeX output --------------------------------------------------
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = 'images/mahara_logo.png'
latex_use_parts = False
LATEX_MAINFONT = 'FreeSerif'
LATEX_BABEL = '\\usepackage{babel}'
LATEX_TITLE = "Mahara user manual"
LATEX_AUTHOR = "Catalyst IT and others"
language = os.environ.get('sphinxlang', 'en')
if language == 'ja':
LATEX_MAINFONT = 'WenQuanYi Micro Hei'
LATEX_TITLE = "Mahara ユーザマニュアル"
LATEX_AUTHOR = "Catalyst IT および他の著者。"
elif language.startswith('zh'):
LATEX_MAINFONT = 'WenQuanYi Micro Hei'
elif language == 'nl':
LATEX_BABEL = '\\usepackage[dutch]{babel}'
LATEX_TITLE = "Mahara handleiding"
LATEX_AUTHOR = "Catalyst IT en andere autheurs."
elif language == 'de':
LATEX_BABEL = '\\usepackage[german]{babel}'
LATEX_TITLE = "Mahara Benutzerhandbuch"
LATEX_AUTHOR = "Catalyst IT und andere Autoren"
elif language == 'fr':
LATEX_BABEL = '\\usepackage[frenchb]{babel}'
LATEX_TITLE = "Manuel de l'Utilisateur de Mahara"
LATEX_AUTHOR = "Catalyst IT et d'autres auteurs"
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Mahara.tex', LATEX_TITLE, LATEX_AUTHOR, 'manual')
]
LATEX_PREAMBLE = '''
\\RequirePackage{ifxetex}
\\RequireXeTeX
\\usepackage{xltxtra}
\\usepackage{verbatim}
\\usepackage{url}
\\usepackage{fontspec}
\\setmainfont{%s}
\\usepackage{amsmath}
\\usepackage{amsfonts}
\\usepackage{xunicode}
''' % (LATEX_MAINFONT)
latex_elements = {
'papersize': 'a4',
'pointsize': '10pt',
'inputenc': '',
'babel': LATEX_BABEL,
'preamble': LATEX_PREAMBLE,
}
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'mahara', 'Mahara user manual',
['Catalyst IT and others'], 1)
]
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = 'Mahara {} user manual'.format(release)
epub_author = 'Catalyst IT and others'
epub_publisher = 'Mahara Project'
epub_copyright = '{} Dual licensed under Creative Commons BY-SA 3.0 unported and GNU General Public License version 3 or later, Catalyst IT and others'.format(copyright_years)
# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''
# A unique identification for the text.
#epub_uid = ''
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
#epub_exclude_files = []
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True
locale_dirs = ["locales/"]