Как проверить локально созданные файлы 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. развить репо
2. клонировать вилку локально
3. настроить подходящую виртуальную среду (так как textX - это библиотека python, а также mkdocs)
4. установить подходящие необходимые библиотеки, указанные в requirements.txt или же requirements_dev.txt в зависимости от репо
5. бежать mkdocs serve

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