2015-05-07 1 views
2

Мы используем сфинкс для документирования нашей колбы api. Это очень хорошая работа, но у нас возникла проблема с обработкой создаваемой документации. Мы документируем каждый проект отдельно. Наши чертежи довольно большие. Каждый из них имеет длину около 1000 строк, а наши докстры очень детализированы. Результатом является страница сфинкса, в которой перечислены конечные точки, но с такой большой промежуточной документацией между конечными точками, что очень сложно понять страницу. Нормальная вещь для создания здесь была бы оглавлением наверху. Я считаю, что sphinx autosummary также может быть вызван здесь, хотя я не знаю точно, поскольку я никогда не использовал его.Резюме или тоск для автофлава сфинкса

К сожалению, autosummary не работает, поскольку он, похоже, не построен для обработки такого же ввода, как autoflask (sphinxcontrib.autohttp.flask). Кто-нибудь знает, как заставить sphinx создать оглавление, которое создает ссылки внутри страницы для всех участников на странице, совместимых с autoflask?

ответ

1

Оказывается, есть html-файл, который генерируется в папке сборки с именем http-routingtable.html, что делает то, что я прошу выше. Учитывая цель sphinx (документация), вы бы подумали, что это будет ... документировано ... ясно. Надеюсь, что другие люди столкнутся с этой проблемой в будущем.

Смежные вопросы