Используя Sphinx, как я могу удалить заголовок, появляющийся в таблице контекста боковой панели? - PullRequest
Новая
       46

Используя Sphinx, как я могу удалить заголовок, появляющийся в таблице контекста боковой панели?

6 голосов
/ 02 сентября 2011

Скажите, мой some.rst файл выглядит так: 

============
My Title
============

1. Section
================

2. Section
=================

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

Мой заголовок

  1. Раздел
  2. Раздел

Есть ли простой способ удалить «My Title» из оглавления в some.html?

Ответы [ 4 ]

3 голосов
/ 09 марта 2018

Мне удалось решить эту проблему с помощью метода .. raw:: html, как описано выше, с небольшим изменением (что позволило избежать взлома автоматически сгенерированного оглавления).как описано ранее, если ваш файл содержит только .. raw:: html заголовков, он нарушит автоматически сгенерированное содержание Sphinx.однако, если вы используете .. raw:: html и добавляете --------------------- под ним, оно не будет отображаться на левой навигационной панели и не нарушит оглавление.например,

, так что я наконец-то случайно понял, как заставить заголовки не отображаться в левом оглавлении.если ваш файл содержит только заголовки .. raw:: html h2, он нарушит автоматически сгенерированное содержание sphinx (как упомянуто в статье stackoverflow).однако, если вы используете .. raw:: html и --------------------- под ним, он не будет отображаться на левой навигационной панели и не нарушит оглавление: star2: например, 

.. raw:: html

   <h2>What Can I Do With KSQL?</h2>

---------------------
3 голосов
/ 08 мая 2014

Самый простой способ - использовать тип объекта, который игнорируется директивой TOC: 

.. rubric:: My Title

Это создает текст, который выглядит как заголовок, но исключен из TOC.Вы можете обновить свой CSS-файл любым стилем, который вы хотите для класса .rubric, даже подражая стилю h1, если хотите.

См. " Заголовки без TOC на странице Restructuredtext " длякак определить рубрику в стиле классов.

2 голосов
/ 06 сентября 2011

Если вы пытаетесь удалить его из всех ваших документов, попробуйте , настроив шаблон по умолчанию .В противном случае вам нужно будет изменить HTML Builder , создав подкласс.

1 голос
/ 20 октября 2016

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

Мое решение закончилось добавлением необработанного html в some.rst: 

:raw-html:`<h1>My Title</h1>`

1. Section
================

2. Section
=================
...