Вывести имя метода / функции, откуда исходит директива Sphinx - PullRequest
0 голосов
/ 10 апреля 2019

Я создал собственное расширение для документации Sphinx внутри pytest в соответствии с примером ToDo.Это чтение и сбор "test_summary" из каждой строки документации каждой pytest test_function.

def test_sphinx():
    """
    This is the first sentence in the test_sphinx test case.

    .. test_summary:: This is the test summary one

    """
    pass 

Это работает нормально.

Теперь мне нравится собирать эти test_summaries внутри собственного файла.пример на данный момент:

 File collection_of_test_summaries:


Test_summary
This is the test summary one

Это тоже работает.Но мне нравится печатать имя функции, здесь: «test_sphinx» для каждой директивы, например:

 File collection_of_test_summaries:


test_sphinx:
Test_summary
This is the test summary one

В соответствии с примером ToDo Sphinx у меня есть имя документа (модуля), но яне удалось найти имя функции.

Спасибо за любую помощь.

Пример сфинкса: https://www.sphinx -doc.org / ru / master / development / tutorials / todo.HTML

1 Ответ

0 голосов
/ 11 апреля 2019

Я нашел решение:

Я использую

self.content.items[0][0].split()[-1]

внутри

run()

функция

class MyDirective(SphinxDirective):

класс.

Это отлично работает.

...