Быстрый старт#

Эта инструкция поможет вам быстро начать работу с проектом.

Для упрощения управления процессом сборки мы будем использовать Docker, а для сборки Docker-образа, запуска и удаления контейнера с проектом, мы будем использовать команды: make build, make run и make clean.

Для того чтобы установить и запустить сайт на локальном сервере, выполните следующие шаги:

  1. Проверьте, что на локальном компьютере установлен Python версии 3.8 или выше.

  2. Установите Docker Desktop и Docker Compose.

  3. Клонируйте репозиторий проекта с GitHub:

    git clone https://github.com/techwri/techwritersru.git

  4. Перейдите в папку проекта.

    cd techwritersru

  5. Переименуйте файл Dockerfile_local в Dockerfile

  6. Соберите Docker-образ:

    make build

  7. Запустите Docker-контейнер:

    make run

Сайт будет доступен по адресу http://localhost:8000.

  1. Для удаления Docker контейнера, выполните команду:

make clean

Поздравляем! Вы успешно установили сайт и готовы начать его использовать ( можно первым делом поправить эту инструкцию:)).

Генерация статичного сайта#

Чтобы выполнить сборку статичного сайта на локальном компьютере без docker, необходимо установить следующие зависимости:

  • Python 3.8 и выше

  • Sphinx

  • sphinx-book-theme

Note

Полный список приведен в файле requirements.txt

Для установки выполните команду:

Note

Установите pip, если вы еще не сделали этого!

pip install -r requirements.txt

Для генерации сайта выполните команду:

make html

Сайт будет собран и сохранен в директории build/html.