Как создавать пользовательские директивы в Sphinx
В настоящее время я документирую API отдыха, написанный на Python. Вся документация проекта создается с использованием Sphinx, и для REST API я хотел бы создать несколько специальных директив. Например, допустим, у меня определен этот ресурс:
@resource("/user/<email>", method="GET")
def user_details (email):
""" Returns detailed information about a user account.
:resource GET: /user/<email>
:query_param a_param: Some kind of query param.
"""
# Do stuff and return user details
Это в основном то, как в настоящее время выглядит документация. Я хотел бы иметь возможность создать директиву для Sphinx, которая форматирует один или несколько из них:query_param ...:
так же, как это происходит с обычным:param:
.
Я нашел, как создавать роли, но они работают только встроенно, а не для блоков данных.
How я должен сделать это?