EDIT:
This is obsolete as the docs (and PRs) are built fully automated in all languages.
Hey,
@Dannyps and I tried to build the docs manually to check formatting and spelling in our language. I must admit that there are several steps involved to build it sucessfully… I did it this way (on Windows 8.1 x64):
Before you start:
-get python and install it on your machine
-get sphinx (see also: http://sphinx-doc.org/tutorial.html)
-get ReadTheDocs Theme (optional)
- Get the complete SpongeDocs off Github (download *.zip here: GitHub - SpongePowered/SpongeDocs: Documentation for Sponge and its Implementations)
- Unzip in your workdir (anywhere you want; i prefer c:\spongedocs)
- Load all *.po and *.pot files off Transifex (in your preferred language)
- in CMD: pip install sphinx-intl (this will install sphinx intl)
- in CMD: navigate to your work-dir and run make gettext
- copy ReadTheDocstheme.zip to your /workdir/source folder
- edit conf.py in /workdir/source:
html_theme = 'readthedocs'
html_theme_path = ['.']
language='YOUR-LANGUAGE'
locale_dirs = ['../build/locale/']
- in CMD: sphinx-intl update -p build/locale -l YOUR-LANGUAGE --locale-dir FULL-PATH-TO-LOCALE-DIR
- replace all *.po in /locale/yourlanguage/ and *.pot in /locale with the ones you got off transifex
(batch rename may come in handy… ) - in CMD: make html
Thats it. Your build is placed in workdir/build/html.
Go there and open index.html.
Sneakpeak/proof: