Как протестировать репозиторий github mkdocs, созданный локально в Mac OS X?

Есть репозиторий GitHub, который мне нравится вносить изменения в его документы. Он использует readthedocs для размещения и mkdocs для темы.

Я использую macOS Мохаве.

Я нашел это https://docs.readthedocs.io/en/latest/install.html руководство по установке для установки readthedocs. Но я не понимаю, как я могу протестировать встроенные файлы после того, как я изменю файл mkdocs.yml репо, в который я хочу внести изменения.

Итак, как мне протестировать встроенные файлы для readthedocs, когда я вношу изменения в mkdocs.yml локально в macOS X?

Я не против использовать докер, если это необходимо.


read-the-docs mkdocs
person Kim Stacks    schedule 22.12.2018    source источник
comment
что вы подразумеваете под тестированием, модульным тестированием или интеграционным тестированием или чем-то еще?   -  person suyashjoshi    schedule 02.07.2021

Ответы (1)


arrow_upward
0
arrow_downward

Моя ментальная модель проблемы неверна. ReadTheDocs — это просто служба, использующая генератор документации (sphinx или mkdocs) и размещающая созданные выходные файлы.

Чтобы запустить mkdocs локально, просто:

  1. раскошелиться на репо
  2. клонировать форк локально
  3. настройте подходящую виртуальную среду (поскольку textX — это библиотека Python, а также mkdocs)
  4. установите подходящие требуемые библиотеки, указанные в requirements.txt или requirements_dev.txt в зависимости от репо
  5. беги mkdocs serve

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

person Kim Stacks    schedule 24.12.2018