Некоторые хорошие примеры настройки Sphinx?

Я создал документ Sphinx, используя sphinx-quickstart.

  • Есть ли хорошие примеры/учебные пособия по настройке внешнего вида? В частности, чтобы изменить заголовок и добавить логотип.

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

update: Добавление эмблемы поддерживается в настройках по умолчанию, просто не очень хорошо документировано. Посмотрите conf.py для параметров *_logo.

Ответы

Ответ 1

Посмотрите на некоторые из эти темы. Поскольку проекты имеют открытый исходный код, вы должны иметь возможность внимательно их изучить.

Ответ 3

Документация Matplotlib - отличный пример, я думаю. Они даже имеют подробное описание в documenting matplotlib: динамически генерируемые цифры и диаграммы наследования - это их собственные расширения для Sphinx, я думаю. Их документация также имеет собственный логотип.

Я бы предположил, что вы должны иметь возможность загружать источник документа RST для большинства проектов.

Ответ 5

Мне всегда нравились SQLAlchemy docs. Они очень сильно отличаются от стандартных тем Sphinx и очень хорошо вписываются в их сайт.

Ответ 6

blender.org новые документы API только что получили макияж, тема сфинкса также загружается.


сайта  http://www.blender.org/documentation/blender_python_api_2_59_release

Основной сайт (тема которого основана)
 http://www.blender.org/

Файлы тем https://svn.blender.org/svnroot/bf-blender/trunk/blender/doc/python_api/blender-org/

Только один пример, который я знаю, но интересно посмотреть, насколько близко матч.

Ответ 7

Перейдите в http://pypi.python.org и найдите sphinx template. Он даст список из нескольких десятков шаблонов. Затем каждый из них можно загрузить и попробовать.