Как настроить документацию с помощью MkDocs?Python

Программы на Python
Ответить
Anonymous
 Как настроить документацию с помощью MkDocs?

Сообщение Anonymous »

Я пытался настроить MkDocs для небольшого локального проекта с использованием ChatGPT, но это не удалось. Вот какая у меня структура папок:
- mymodule/
| - __init__.py
| - tester.py
- docs/
| - docs/
| - mkdocs.yaml


и этот файл mkdocs.yml содержит:
site_name: Test Documentation

theme:
name: mkdocs

plugins:
- search
- mkdocstrings:
handlers:
python:
setup_commands:
- "import sys, os; sys.path.insert(0, os.path.abspath('../mymodule'))"


Но он не работает при запуске службы mkdocs. Как это можно исправить? Мне просто нужна документация по нескольким файлам в этой папке mymodule.
Сообщение об ошибке:
$ mkdocs serve
INFO - Building documentation...
Traceback (most recent call last):
File "/Users/alex/.pyenv/versions/3.12.8/bin/mkdocs", line 8, in
sys.exit(cli())
^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/click/core.py", line 1485, in __call__
return self.main(*args, **kwargs)
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/click/core.py", line 1406, in main
rv = self.invoke(ctx)
^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/click/core.py", line 1873, in invoke
return _process_result(sub_ctx.command.invoke(sub_ctx))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/click/core.py", line 1269, in invoke
return ctx.invoke(self.callback, **ctx.params)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/click/core.py", line 824, in invoke
return callback(*args, **kwargs)
^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocs/__main__.py", line 272, in serve_command
serve.serve(**kwargs)
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocs/commands/serve.py", line 85, in serve
builder(config)
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocs/commands/serve.py", line 67, in builder
build(config, serve_url=None if is_clean else serve_url, dirty=is_dirty)
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocs/commands/build.py", line 265, in build
config = config.plugins.on_config(config)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocs/plugins.py", line 587, in on_config
return self.run_event('config', config)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocs/plugins.py", line 566, in run_event
result = method(item, **kwargs)
^^^^^^^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocstrings/_internal/plugin.py", line 153, in on_config
handlers._download_inventories()
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocstrings/_internal/handlers/base.py", line 602, in _download_inventories
handler = self.get_handler(handler_name)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocstrings/_internal/handlers/base.py", line 583, in get_handler
self._handlers[name] = module.get_handler(
^^^^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocstrings_handlers/python/_internal/handler.py", line 403, in get_handler
config=PythonConfig.from_data(**handler_config),
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/alex/.pyenv/versions/3.12.8/lib/python3.12/site-packages/mkdocstrings_handlers/python/_internal/config.py", line 1142, in from_data
return cls(**cls.coerce(**data))
^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: PythonConfig.__init__() got an unexpected keyword argument 'setup_commands'


Подробнее здесь: https://stackoverflow.com/questions/798 ... ith-mkdocs
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «Python»