Краткое руководство по началу работы с документацией Scrapy

Данный файл содержит краткое руководство по составлению документации Scrapy.

Настраивает среду

Для компиляции документации вам понадобится библиотека Sphinx Python. Чтобы установить его и все его зависимости, выполнить следующую команду из этого каталога

pip install -r requirements.txt

Составьте документацию

Чтобы скомпилировать документацию (для классического вывода HTML), выполнить следующую команду из этого каталога:

make html

Документация будет создана (в формате HTML) внутри каталога build/html.

Просмотрите документацию

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

make htmlview

Эта команда запустит ваш браузер по умолчанию и откроет главную страницу вашей (ранее созданной) HTML-документации.

Начать сначала

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

make clean

Имейте в виду, что эта команда не затрагивает исходные файлы документации.

Создание документации на лету

Есть способ автоматически воссоздать документ при внесении изменений, вам нужно установить сторожевой таймер (pip install watchdog), а затем использовать:

make watch

Альтернативный метод с использованием tox

Чтобы скомпилировать документацию в HTML, выполнить следующую команду:

tox -e docs

Документация будет создана (в формате HTML) внутри каталога .tox/docs/tmp/html.