Настройка темы sphinxdoc

есть ли простой способ настроить существующий sphinxdoc тема? Для темы по умолчанию есть много атрибутов темы, но в sphinxdoc я даже не могу установить логотип или изменить некоторые цвета?

или вы можете порекомендовать мой сайт, где я могу узнать, как изменять темы?

6
python python-sphinx themes

3 ответов

все, что я хотел это добавить отдых зачеркнуть в моем Сфинксе doc. Вот как я это сделал:

$ cd my-sphinx-dir
$ mkdir -p theme/static
$ touch theme/theme.conf
$ touch theme/static/style.css

на theme/theme.conf:

[theme]
inherit = default
stylesheet = style.css
pygments_style = pygments.css

(это делает его похожим на тему по умолчанию (l. 2))

на theme/static/style.css:

@import url("default.css"); /* make sure to sync this with the base theme's css filename */

.strike {
    text-decoration: line-through;
}

тогда, в вашем conf.py:

html_theme = 'theme' # use the theme in subdir 'theme'
html_theme_path = ['.'] # make sphinx search for themes in current dir

подробнее здесь: https://sphinx.readthedocs.io/en/master/theming.html.

(необязательно) в global.РСТ:

.. role:: strike
   :class: strike

и в Примеру.РСТ:

.. include:: global.rst

:strike:`This looks like it is outdated.`
11

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

_template и _static подпапках

в папке документации sphinx (с именем docs в этом примере), создайте две подпапки: _static и _templates: 

docs
├── conf.py
├── index.rst
└── _templates
    └── page.html
└── _static
    └── style.css

style.css таблицы стилей

на , создайте файл style.css содержит параметры CSS, которые вы хотите перезаписать. Вы можете найти подходящие варианты по sphinxdoc тема таблицы стилей, внутри папки установки sphinx:

./python3.4/site-packages/Sphinx-1.3.1-py3.4.egg/sphinx/themes/sphinxdoc/static/sphinxdoc.css_t`

изменить фон с белого на черный, добавить в него следующие строки style.css:

body {
    background-color: black;
    color: white;
}
div.document {
    background-color: black;
}

чтобы добавить возможность центрировать код с помощью .

дополнительная информация

эти инструкции взяты из документации Tinkerer по тематике:http://tinkerer.me/doc/theming.html. Тинкерер движок блогов на основе Sphinx.

Также см.: как добавить пользовательский файл css?.

8

Если я вас правильно понял, то стандартная документация по Сфинксу говорит вам, как изменить существующие и создавать новые темы.

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

Если вы хотите изменить макет CSS, вы можете добавить файлы CSS (или изображения) в _static поддиректорию ваш source и редактировать conf.py по мере необходимости. Опять же, тема облака была моим лучшим примером для этого.

4