Как сделать кликабельную ссылку совместимой с IDES и MKDOCS? ⇐ Python

[Anonymous]

Мои доктора содержат ссылки. Я хочу сделать эти ссылки, кликабельными в IDE, но я хочу использовать https://github.com/mkdocstrings/python для создания ссылки на API MkDocs.
Я хочу использовать этот пакет, потому что остальная часть моей документации. находится в уценке и, таким образом, генерируется с использованием MKDOCS, и его легче настроить, чем объединять MKDOCs с помощью, например, sphinx.
Я знаю > Google, Numpy и Sphinx. Я прошел документацию отдельных форматов:

• https://sphinx-rtd-tutorial.readthedocs ... s.html#the -sphinx-docstring-format
• https://numpydoc.readthedocs.io/en/latest/format.html
• https: // sphinxcontrib -napoleon.readthedocs.io/en/latest/example_google.html

Но не нашел удовлетворительный ответ:
Я пытался положить Следующие ссылки на мой docstring: < /p>

Код: Выделить всё

def foo():
"""

link1
`Example `_

link2
`Example `

link3


link4
_Example: http://www.example.com

link5
_`Example `_

link 6
http://www.example.com

link7
[example](http://www.example.com)

link8
[url=http://www.example.com]example[/url]
"""

, который отображает следующий результат в визуализации DOC в pycharm:
< /p>
Тогда я использовал < /p>

Код: Выделить всё

::: my_package_name

для ссылки API и следующего mkdocs.yaml is:

Код: Выделить всё

plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [src]
options:
allow_inspection: true
show_submodules: true

Но рендерированный HTML выглядел так:
< /p>
Таким образом, нет единого формата, который бы был отображаться одинаково как в mkdocstring, так и в нативной документации. < /p>
Есть ли какие -либо Как это достичь, или мне нужно написать свой собственный препроцессор MKDOCS?


Подробнее здесь: https://stackoverflow.com/questions/787 ... and-mkdocs