Skip to content

elvees/review

Repository files navigation

Правила и руководства по разработке на review.elvees.com

Для сборки Sphinx-проекта необходимо создать виртуальное окружение и установить зависимости из requirements.txt.

Версия Python, на которой проверяется собираемость проекта указана в .readthedocs.yaml. Ожидается собираемость на любой версии поддерживаемой зависимостями.

Пример сборки с использованием Pipenv:

pipenv install --skip-lock
pipenv run make html
# open build/html in browser

При обновлении requirements.txt рекомендуется переустанавливать среду:

pipenv --rm
pipenv install ...

Note

Pipfile{,.lock} не добавляется в репозиторий (Read the Docs позволяет устанавлить зависимости только из requirements.txt).