Как добавить фрагменты кода в строку документации Python (не как doctest)?

Question

Я бы хотел предоставить фрагменты кода, чтобы продемонстрировать, как можно использовать определенный метод или класс в python.Как я могу это сделать?

В Java можно использовать ... для этого.

Doctest - единственный способ? Как яПосмотрите на существующие строки документации для типичных пакетов (например, pandas, numpy и т. д.), я никогда не вижу ничего, кроме doctest, предназначенного для тестирования метода, а не только для форматирования текста в виде кода Python.Итак, если doctest является единственным способом, каким будет правильный способ форматирования фрагмента кода, чтобы он выглядел как интерактивные сеансы Python?Я не хочу каждый раз писать свой код в интерактивном сеансе, а затем записывать его в моей строке документации.Это не похоже на правду.

Answer 1

DocStrings не единственный способ.Если вы используете Sphinx для генерации документации, тогда вам следует прочитать .

Пример

Here is something I want to talk about:: <-- Special syntax to mark code beginning

    def my_fn(foo, bar=True): # Code itself
        """A really useful function.

        Returns None
        """