API для шаблонов

Переменные и функции, доступные шаблону при сборке документации в HTML.

API Собираки может дорабатываться и меняться от проекта к проекту.

API для всех форматов #

  • builder — объект-сборщик.

  • project — текущий проект.

  • document — текущий документ.

  • config — объект для доступа к настройкам текущего документа.

  • head — дополнительный код, который необходимо добавить внутрь тега <head>.

  • toc() — функция, генерирующая оглавление по текущему документу.

API для сборки HTML #

  • number — номер страницы, если в документе включена автонумерация.

  • title — заголовок страницы.

  • body — содержимое страницы без заголовка, преобразованное в HTML.

  • page — объект для доступа к текущей странице.

  • ROOT — относительный путь к корню документации. Пример: ...

  • ROOT_PAGE — относительный путь к главной странице документации. Примеры: .., ../index.html.

  • RESOURCES — относительный путь к директории с изображениями и другими ресурсами. Пример: ../images.

  • STATIC — относительный путь к директории, в которую будут скопированы ресурсы из поддиректории _static используемой темы. Пример: ../static.

  • theme_data — словарь с произвольными данными из настройки web.theme_data.

  • now — текущие дата и время, полученные с помощью datetime.now().

  • Language — класс для получения названия языка. См. библиотеку iso639.

  • local_toc() — функция, генерирующая оглавление по текущей странице.

API для сборки PDF #

  • content — список кортежей, каждый из которых содержит четыре элемента:

    • объект для доступа к текущей странице;
    • номер страницы, если в документе включена автонумерация;
    • заголовок страницы;
    • содержимое страницы без заголовка, преобразованное в HTML.