Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit configurations #37

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,28 @@ openprocurement.auctions.dgf repository contains code for Deposit Guarantee Fund

Documentation can be found here http://dgf.api-docs.openprocurement.org/uk/latest/

Use following commands to build documentation from `docs/source` into `docs/html`::

python bootstrap.py -c docs.cfg
bin/buildout -N -c docs.cfg
bin/docs

For translation into *<lang>* (2 letter ISO language code), you have to follow the scenario:

1. Pull all translatable strings out of documentation::

(cd docs/_build; make gettext)

2. Update translation with new/changed strings::

bin/sphinx-intl update -c docs/source/conf.py -p docs/_build/locale -l <lang>

3. Update updated/missing strings in `docs/source/locale/<lang>/LC_MESSAGES/*.po` with your-favorite-editor/poedit/transifex/pootle/etc. to have all translations complete/updated.

4. Compile the translation::

bin/sphinx-intl build -c docs/source/conf.py

5. Build translated documentations::

(cd docs/_build; make -e SPHINXOPTS="-D language='uk'" html)
1 change: 1 addition & 0 deletions buildout.cfg
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[buildout]
index = https://pypi.python.org/simple/
extends = versions.cfg
newest = false
parts = test
Expand Down