Попробовал начать писать документацию. Синтаксис
.md
На локальной машине с использую mkdocs все работает замечательно, пишу
mkdocs serve
у меня запускается сервер с отображением документации.
На картинке показано расположение документации: папка - /docs. Конфигурационный файл mkdocs.yml для mkdocs лежит в корне проекта.
Хочу для хостинга документации использовать Сервис Read the Docs, Но при попытке билда, появляется ошибка:
При этом, если я попробую запустить команду
mkdocs build --clean
на локальной машине, папка site с документацией без проблем создается в корне проекта.
Полный лог ошибки:
WARNING - Config value: 'nav'. Warning: Unrecognised configuration name: nav
INFO - Cleaning site directory
INFO - Building documentation to directory: /home/docs/checkouts/readthedocs.org/user_builds/ray62/checkouts/latest/_build/html
Traceback (most recent call last):
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/mkdocs/nav.py", line 337, in _follow
raise StopIteration
StopIteration
The above exception was the direct cause of the following exception:
Traceback (most recent call last):
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/bin/mkdocs", line 10, in <module>
sys.exit(cli())
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/click/core.py", line 764, in __call__
return self.main(*args, **kwargs)
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/click/core.py", line 717, in main
rv = self.invoke(ctx)
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/click/core.py", line 1137, in invoke
return _process_result(sub_ctx.command.invoke(sub_ctx))
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/click/core.py", line 956, in invoke
return ctx.invoke(self.callback, **ctx.params)
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/click/core.py", line 555, in invoke
return callback(*args, **kwargs)
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/mkdocs/__main__.py", line 156, in build_command
), dirty=not clean)
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/mkdocs/commands/build.py", line 282, in build
build_pages(config, dirty=dirty)
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/mkdocs/commands/build.py", line 213, in build_pages
site_navigation = nav.SiteNavigation(config)
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/mkdocs/nav.py", line 44, in __init__
config, self.url_context)
File "/home/docs/checkouts/readthedocs.org/user_builds/ray62/envs/latest/lib/python3.7/site-packages/mkdocs/nav.py", line 392, in _generate_site_navigation
config_line, url_context, config):
RuntimeError: generator raised StopIteration
Подскажите, как правильно захостить документацию на Read the Docs?
UPD: Проблема решена путем изменения версии питона с 3 на 2 в админке read the docs