разметка sphinx в кодовой строке - PullRequest
Новая
       10

разметка sphinx в кодовой строке

0 голосов
/ 16 мая 2018

Я хотел бы использовать Sphinx для генерации документа для моего приложения.Моя цель - написать комментарии в коде для разных аудиторий, а затем сгенерировать документацию в соответствии с целевой аудиторией.

Другими словами, я хотел бы использовать что-то вроде .. only:: непосредственно в своем коде.

Например: 

def myFunction(self):
    """ myFunction general description

    .. only:: dev
        Some specififc infos for dev

    .. only:: user
        Some specific infos for user

    :returns:
        Description of return of myFunction
    """

Затем, позвонив: 

sphinx-build.exe -t dev -b html source buildDev

ИЛИ 

sphinx-build.exe -t user -b html source buildUser

Я получу обе версии документа.

Я не знаю, достаточно ли я ясен.Будет ли это возможно?

...