Issues/33 translate documentation into eng
Описание
Какую пользу приносит данный MR, кому и зачем он нужен
Программист, контрибьютор: может получить информацию о библиотеке как на русском, так и на английском языках
Какие изменения были внесены
Добавлена документация на английском языке
Полезные ссылки и прочий контекст задачи
Чеклист к описанию MR:
-
В описании MR указана польза от изменений: кто получит пользу и почему он хочет этого -
В описании MR указаны ссылки на соответствующие issues в GitLab, если есть -
В описании MR приложены фрагменты переписки и/или ссылки на обсуждения, если такие велись за пределами GitLab Issues
Чеклист к коду в репозитории:
[ ] Новый код покрыт автотестами[ ] К каждому новому автотесту в docstring описана функция и история в формате Product Flow-
[ ] Документы Product Flow проверены и обновлены, если требуется[ ] новый код совместим с!extensionк старым концептам[ ] новый код не влезает в!exclusionк старым концептам[ ] добавлены новые!exampleв концепты, если требуется
-
Дока в README перечитана и обновлена, если требуется -
Дока в CONTRIBUTING.md перечитана и обновлена, если требуется -
Дока в sphinx_docs/source/index.rst перечитана и обновлена, если требуется -
Обновлён файл CHANGES.md
Добавить документацию на readthedocs:
- Необходимо создать еще один проект в readthedocs для документации на английском языке на основании того же репозитория. При создании необходимо указать: язык - english.
- После создания в настройках проекта необходимо вручную прописать путь до .readthedocs.yaml: sphinx_docs/en/source/.readthedocs.yaml
- В настройках ранее существующего проекта необходимо поменять язык на русский и путь до файла .readthedocs.yaml: sphinx_docs/ru/source/.readthedocs.yaml (это будет проект для документации на русском языке)
- Чтобы засинкать проекты между собой, необходимо в настройках одного проекта в разделе Translations указать второй проект (Settings - Translations)
- Настройку Versioning scheme: Multiple version with translations - лучше оставить так, она не влияет на перевод, но добавит к урлу en или ru.
Edited by Елена Иванова