backend.ai-docs-console
User's guide for Backend.AI GUI Console.
Setup build environment
We use poetry to manage dependencies and packaging. Poetry can be installed by the following command.
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
source ~/.poetry/env # == export PATH="$HOME/.poetry/bin:$PATH"We recommend to use virtualenv. After virtualenv setup, run following command to install dependent packages.
poetry installBuild documents
To build html documentation, run following command in the docs directory. All
commands should be executed under poetry's virtual environment. For example, you
can run poetry shell to enter a command shell with virtualenv.
make htmlBuilt documents will be located under docs/_build.
Translation
When English document is updated, extract translatable messages into .pot
files. Go to docs directory and run following command.
make gettextFrom those .pot files, .po message catalogs can be generated:
sphinx-intl update -p _build/gettext -l koNow, .po files are generated in locale/ko/LC_MESSAGES/. Translate messages
with them. For eaiser .po translation, you may use GUI apps like
POEDIT.
Note that Korean a character should not be followed by two backticks(``) WITHOUT A SPACE, since that will raise compilation errors.
After translation, run following to build translated html document. To build a
pdf document, just replace html to latexpdf. Note that your local machine
should be prepared with latex generation environment, such as MacTex, to make
pdf file.
make -e SPHINXOPTS="-D language='ko'" htmlTo see the local html documents:
open _build/html/index.htmlReferences for newcomers
http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html