Russian Docs Translation / Русская Документация Sponge

Sponge Docs
20

Как получить документацию на русском в виде HTML

В общем, это перевод инструкции Building the Docs locally (This is obsolete!), но исправленный и дополненный. Также частично взяты инструкции http://sphinx-doc.org/install.html и https://github.com/snide/sphinx_rtd_theme.
В данный момент документация на сайте доступна только на английском, но документацию на другом языке можно собрать самостоятельно.
Рассматриваю сборку на Windows 7.

  1. Для сборки требуется Python (рекомендуется версия 2.7). Если вдруг он уже установлен, пропустите этот шаг. Примечание: Python 3.x не подойдёт (на самом деле, мне удалось заставить его работать, но для краткости я не буду это описывать). Нужно перейти на Python Releases for Windows | Python.org и выбрать Latest Python 2 Release (на момент написания этой инструкции - Python 2.7.9). Далее выбрать один из MSI installer: x86-64 - для 64-битной системы, x86 - для 32-битной. Если не уверены, выбирайте Windows x86 MSI installer - он заработает и на 64-битной тоже. При установке отметьте пункт “Add python.exe to Path” в списке компонентов.

  2. Откройте командную строку (Пуск - Все программы - Стандартные - Командная строка). Не закрывайте её до конца этой инструкции.

  3. Выполните команду:

    python
    Должна появиться версия Python и приглашение (>>>). Если это не так, значит, на 1-м шаге допущена ошибка. Выйдите из Python, нажав Ctrl+Z и затем Enter.
    Подсказка: чтобы вставить текст в командную строку, щёлкните правой кнопкой и выберите “Вставить” (Ctrl+V не работает).

  4. Создайте папку для дальнейшей работы, например, C:\spongedocs (далее будет подразумеваться, что используется эта папка).

  5. Скачайте https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py и сохраните в C:\spongedocs.

  6. Перейдите в командную строку и перейдите там в папку C:\spongedocs, команда будет выглядеть так:

    cd “C:\spongedocs”
    7.Выполните команды по одной:

    python ez_setup.py
    easy_install sphinx
    pip install sphinx-intl
    pip install sphinx_rtd_theme
    8.Перейдите на GitHub - SpongePowered/SpongeDocs: Documentation for Sponge and its Implementations и нажмите кнопку “Download ZIP” справа. Распакуйте этот архив в C:\spongedocs так, чтобы файл make.bat находился в папке C:\spongedocs.
    9.Выполнить в командной строке:

    make gettext
    10.Откройте файл C:\spongedocs\source\conf.py - щелкните правой кнопкой мыши и выберите Edit with IDLE. Примечание: у меня в этом редакторе не работает Ctrl+V, для вставки используйте ПКМ - Paste. По возможности, используйте продвинутый редактор вроде Programmer’s Notepad (я не буду здесь описывать его установку для краткости).

  7. В этом файле необходимо добавить 1 строку:

    import sphinx_rtd_theme
    после

    import sys, os
    и заменить 4 строки:

    language = ‘ru’
    вместо

    #language = None
    ,

    html_theme = “sphinx_rtd_theme”
    вместо

    html_theme = ‘default’
    ,

    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
    вместо

    #html_theme_path = []
    ,

    locale_dirs = [’…/build/locale/’]
    вместо

    locale_dirs = [‘locale/’]
    12.Сохранить файл (File - Save)
    13.Выполнить в командной строке:

    sphinx-intl update -p build/locale -l ru --locale-dir C:\spongedocs\build\locale
    14.Открыть https://crowdin.com/project/sponge-docs и нажать кнопку Download Translations in a ZIP Archive справа (к сожалению, я не нашёл, как скачать только русский перевод, поэтому придётся скачать все).
    15.Заменить файлы в папке C:\spongedocs\build\locale\ru\ файлами из архива (надеюсь, разберётесь).

  8. Выполнить в командной строке:

    make html
    17.Готово! Документация должна быть в папке C:\spongedocs\build\html (откройте index.html в браузере).

Для обновления перевода достаточно выполнить пункты 2, 6, 14-17.

1 Like