Настройка проекта#

После установки VS Code мы можем настроить проект. Если вы не закрыли консоль, то находясь в папке с сайтом введите команду:

code .

Где . — это путь к открываемой папке, то есть к той, в которой вы находитесь сейчас.

Note

Если вы только открыли консоль и находитесь где-то в другом месте, то можете ввести после code путь до папки с сайтом.

VS Code#

После срабатывания программы перед вам откроется VS Code в папке с вашим сайтом.

VS Code

Первым делом советую установить дополнение, которое будет подсвечивать синтаксис reStructuredText, чтобы было проще ориентироваться в разметке. Например, как у меня:

RST Extension

Index.rst#

Теперь перейдите в основной файл сайта. Он находится в папке source и называется index.rst.

Note

На будущее: переименуйте папку source в папку docs, — в дальнейшем это пригодится.

Чтобы не скакать между окнами предлагаю использовать вам терминал прямо в VS Code. Чтобы его открыть там нажмите сверху на меню Terminal и выберите там пункт New Terminal.

VS Code Terminal

Note

Если используете WSL на Windows 10, то не забудьте ввести bash. Также заново надо войти в виртуальное окружение через команду source venv/bin/activate.

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

sphinx-autobuild docs build

  1. sphinx-autobuild — команда, которая запускает «живую» генерацию сайта.

  2. docs — папка, откуда берутся исходники.

  3. build — папка, куда собирается сайт.

После запуска команды перейдите на локальный хост. Это можно сделать через терминал в VS Code: после введения команды там появится адрес, по которому надо перейти. Зажмите Ctrl на клавиатуре и кликните мышкой по нему.

Localhost

Либо просто введите в своём браузере:

127.0.0.1:8000.

Conf.py#

Если вы ещё не меняли никаких настроек сами, то скорее всего на локальном хосте вы увидите не очень красивую картинку.

Alabaster

Всё дело в том, что мы ещё не обозначили тему, которую будем использовать в проекте. Мы её только скачали. Это и многие другие настройки нужно изменять в файле conf.py.

Conf.py

Здесь вы можете изменить название проекта, копирайт, автора, версию и прочее. В данный момент нас интересует настройка:

html_theme = 'alabaster'

Не удаляя кавычек, введите туда furo вместо alabaster. Или название той темы, которая вам понравилась больше всего. После сохранения файла, сайт должен обновиться и изменить тему.