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

Question

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

Я использую macOS Mojave.

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

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

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

Answer 1

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

Для локального запуска mkdocs просто:

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

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