/
quick_start.rst
102 lines (55 loc) · 3.69 KB
/
quick_start.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
Быстрый старт
#############
Эта инструкция поможет вам быстро начать работу с проектом.
Получение исходного кода
========================
Код проекта хранится на GitHub.
Для получения кода клонируйте репозиторий:
.. code-block::
git clone https://github.com/techwri/techwritersru.git
Каталог с файлами репозитория далее будет называться рабочим каталогом.
Все приведенные ниже команды следует выполнять в рабочем каталоге.
Сборка проекта
==============
Рекомендуемым способом сборки проекта является использование Docker-образа.
Если по какой-либо причине этот способ не подходит, можно использовать виртуальное окружение Python.
Docker
------
Чтобы собрать проект с помощью Docker-образа, выполните следующие действия:
#. Установите Docker Desktop, следуя `инструкциям <https://docs.docker.com/desktop/>`__ для вашей ОС.
#. Соберите Docker-образ:
.. code-block:: bash
make docker-build-image
Для удобства использования образу присваивается тег ``techwriters``.
#. Для сборки проекта выполните команду:
.. code-block:: bash
make docker-build-html
Виртуальное окружение Python
----------------------------
Чтобы собрать проект с помощью виртуального окружения Python, выполните следующие действия:
#. Установите интерпретатор Python версии 3.8 или новее.
#. Установите менеджер Python-пакетов PIP, если он не был установлен вместе с интерпретатором.
#. Установите пакет ``venv`` для управления виртуальными окружениями, если он не был установлен вместе с интерпретатором.
.. note:: Подробнее о пакете ``venv`` см. в `документации Python <https://docs.python.org/3/library/venv.html>`__.
#. Создайте виртуальное окружение:
.. code-block:: bash
python3 -m venv .venv
#. Активируйте созданное виртуальное окружение:
.. code-block:: bash
source .venv/bin/activate
#. Установите пакеты, список которых представлен в файле :file:`requirements.txt`.
.. code-block:: bash
pip install -r requirements.txt
#. Для сборки сайта выполните команду:
.. code-block:: bash
make html
Запуск локального сервера
-------------------------
Для запуска локального сервера выполните следующие действия:
#. Установите интерпретатор Python версии 3.8 или новее.
#. Соберите проект любым описанным выше способом.
#. Выполните команду:
.. code-block:: bash
python3 -m http.server -d build/dirhtml
Собранный сайт будет доступен локально по адресу http://127.0.0.1:8080/.
.. http://127.0.0.1:8080/ no_check: true