Я бы хотел документировать INI-файл в моей документации Sphinx. Какую разметку я должен использовать?
Всякий раз, когда я ищу в Интернете, я получаю описание файла конфигурации Sphinx - conf.py.
Стандартный домен имеет несколько инструментов для документирования программ командной строки, и можно использовать роль describe (object), но, как указано в документации, «эта директива производит такое же форматирование, что и определенные предоставляется доменами, но не создает записей индекса или целей перекрестных ссылок "
Мне нужно что-то более конкретное, чтобы описать разделы и параметры и иметь возможность ссылаться на них.
Итак, имея INI-файл:
[ui]
username = Mike
e-mail = mike@domain.com
Я бы хотел использовать что-то вроде этого:
.. ini:section:: ui
This section contains setting for use interface
.. ini:option:: username
User name
...
Есть ли лучший способ сделать это, чем написать собственное расширение?
Всякий раз, когда я ищу в Интернете, я получаю описание файла конфигурации Sphinx - conf.py.
Стандартный домен имеет несколько инструментов для документирования программ командной строки, и можно использовать роль describe (object), но, как указано в документации, «эта директива производит такое же форматирование, что и специфические, предоставляемые доменами, но не создающие записи индекса или цели перекрестных ссылок ".
Мне нужно что-то более конкретное, чтобы описать разделы и параметры и иметь возможность ссылаться на них.
Итак, имея INI-файл:
[ui]
username = Mike
e-mail = mike@domain.com
Я бы хотел использовать что-то вроде этого:
.. ini:section:: ui
This section contains setting for use interface
.. ini:option:: username
User name
...
И ссылаться на него в
Есть ли лучший способ сделать это, чем написать собственное расширение?