Локализация документации в Sphinx¶

Пошаговое руководство

В этом руководстве показано, как использовать возможности Sphinx для локализации документации, созданной в Sphinx. Основная цель руководства — показать, как использовать sphinx-intl для перевода документации. Но это еще не все. С помощью этого руководства вы можете сделать следующее:

Создать новый проект в Sphinx и настроить его для перевода с помощью sphinx-intl.
Перевести проект и собрать переведенную документацию.
Использовать собственные изображения для каждого языка.
Добавить условный текст, который публикуется только на указанных вами языках.
Разработать простой переключатель языка для справки в формате html.

Шаг за шагом мы создадим и переведем демонстрационный проект с английского на два языка: русский и португальский (бразильский). Надеюсь, после этого вы сможете применить эти знания к своей документации.

Я предполагаю, что вы уже знакомы со Sphinx. В противном случае начните либо с документации Sphinx, либо с Readthedocs.