dev.py

Сценарий dev.py — это интерактивный инструмент CLI, используемый для управления тем, какие страницы документации загружаются во время локальной разработки.

Он заменяет ручную настройку переменных среды и упрощает выборочный запуск частей сайта документации во время разработки.

Требования

Этот сценарий использует questionary для интерактивных подсказок.

Установите его, используя настройки вашего проекта:

uv add questionary

Вы также можете добавить его вручную в свой pyproject.toml:

dependencies = ["questionary"]

Обзор

Вместо того, чтобы каждый раз запускать полную сборку документации, dev.py позволяет вам:

  • Выберите определенные страницы
  • Выбрать целые разделы
  • Выбор страниц в определенных разделах
  • Запустите приложение в режиме dev или prod.

Затем он автоматически настраивает правильные переменные среды и запускает сервер Reflex.

Использование

Запустите скрипт из корня вашего проекта, чтобы запустить интерактивный поток:

uv run dev.py

Поток

CLI следует этому потоку:

  1. Выберите среду (dev/prod)
  2. Выбор режима (страницы/разделы/страницы-разделы)
  3. Выберите страницы или разделы в зависимости от режима.
  4. Подтвердите выполнение
  5. Запустить рефлекс

Окружающая среда

Прежде чем выбирать, что запускать, вы должны выбрать среду.

Это определяет, будет ли CLI запускать полный сайт документации или отфильтрованное подмножество разработки.

Дев

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

Он позволяет выборочную загрузку страниц через dev.py CLI.

Используйте этот режим, когда:

  • Работа над отдельными страницами документации.
  • Отладка структуры контента
  • Ускорение местного развития.

Прод

В рабочем режиме выполняется полная документация сайта без какой-либо фильтрации.

Режимы

страниц

Выберите отдельные страницы из всей доступной документации. Полезно при работе над конкретным контентом или отладке одной страницы.

Разделы

Выберите один или несколько разделов. Все страницы внутри этих разделов будут загружены автоматически. Полезно при работе над областью объекта.

Страницы разделов

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