Использование javascript вместо стандартного toctree Sphinx - PullRequest
Новая
       7

Использование javascript вместо стандартного toctree Sphinx

2 голосов
/ 04 ноября 2011

Я использую sphinx для автоматической генерации html-страниц.Оглавление действительно длинное, поэтому я пытаюсь добавить новый HTML-класс (среди прочего) в div toctree , чтобы я мог использовать библиотеку javascript.В основном, желая изменить, как toctree создает свой HTML.

Я нашел файл globaltoc.html , поместил его в папку _templates и раскомментировал template_path в conf.py .

Этот файл находится в каталоге _templates . 

{% extends '!globaltoc.html' %}

<div class="toctree-wrapper compound dhtmlxTree" id="toc", setImagePath="_static/imgs/csh_dhx_skyblue/">

{{ toctree() }}
</div>

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

Общая цель этого - использовать dhtmlxTree для использования с очень большим деревом.Я уже добавил необходимые файлы .js и .css в layout.html .Мне просто нужен div , который содержит toctree , чтобы получить нужный мне класс.Я могу получить нужные результаты, отредактировав их вручную, теперь мне нужно автоматизировать их.

Спасибо за вашу помощь.

1 Ответ

3 голосов
/ 04 ноября 2011

Я считаю, что есть два возможных решения моей проблемы:

  1. Использование шаблонов Jinja для написания javascript и маркированного списка.В настоящее время я не знаком с использованием рекурсивного флага Jinja.Поэтому это решение, хотя и возможно, может вызвать у меня большее разочарование, чем второе решение.

  2. Простое уменьшение атрибута : maxdepth: для toctree директива.Было установлено значение 4. Уменьшение этого числа делает содержание меньшим и, следовательно, более легким для чтения.

Подумав о , нужно , чтобы увидеть все слои,Я понял, что это было просто глупо, и это уменьшило полезность Оглавления.Поэтому я просто уменьшил : maxdepth: до 2, и все возвращается к простоте, которую предлагают reST и Sphinx.

Лучшая конструкция каждый раз превосходит крутой фактор.

...