def test(foo):
"""this is my function
.. code-block:: python
cool function
now I should be outside the codeblock.
But I'm not?
.. code-block:: python
next function
I'm still inside the original codeblock?
:param foo: _description_
:type foo: _type_
"""
Что в VScode отображается следующим образом:
[img]https://i.stack. imgur.com/CRdby.png[/img]
Я неправильно пишу синтаксис, или у VScode просто проблемы с рендерингом формата sphinx?
Я пытаюсь документировать классы и их методы на одной странице, но получаю либо
Только строка документации классов, но не документация их методов вообще.
или
Классы и их методы на отдельных страницах.
Структура документации, которой я следую,...
Я пытаюсь программно принять («отразить») строки документации в стиле Google. Я использую sphinx.ext.napoleon, поскольку, похоже, не многие инструменты делают это. Я следую этому примеру с помощью приведенной ниже функции:
from sphinx.ext.napoleon...
Я создаю документацию для библиотеки на работе, используя Sphinx. В некоторых подсказках типов используется такое форматирование:
def find_and_read_ugrids(sim_node, query) -> tuple :
Из-за этого я получаю ошибку типа в Sphinx и не понимаю, что...