Python sphinx 使用Sphinx,如何删除侧栏中出现的标题';什么是上下文表?

Python sphinx 使用Sphinx,如何删除侧栏中出现的标题';什么是上下文表?,python-sphinx,tableofcontents,Python Sphinx,Tableofcontents,假设我的some.rst文件如下所示: ============ My Title ============ 1. Section ================ 2. Section ================= 编译后,在生成的some.html中,侧栏中将显示一个目录,如下所示: 我的头衔 部分 部分 是否有一种简单的方法可以从some.html的目录中删除“我的标题”?如果您试图从所有文档中删除它,请尝试。否则,您需要通过创建子类来修改。简单的方法是使用TOC指令忽略的对象

假设我的
some.rst
文件如下所示:

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

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

2. Section
=================
编译后,在生成的
some.html
中,侧栏中将显示一个目录,如下所示:

我的头衔

  • 部分
  • 部分

  • 是否有一种简单的方法可以从
    some.html
    的目录中删除“我的标题”?

    如果您试图从所有文档中删除它,请尝试。否则,您需要通过创建子类来修改。简单的方法是使用TOC指令忽略的对象类型:

    .. rubric:: My Title
    
    这将创建看起来有点像标题的文本,但被排除在TOC之外。您可以为
    .rubric
    类使用您想要的任何样式更新CSS文件,如果您喜欢,甚至可以模仿h1样式


    请参阅“”,了解如何定义量规样式的类。

    我知道,这次聚会已经很晚了。我刚刚遇到这个问题,需要模拟h2,无法编辑样式表

    我的解决方案是在
    some.rst
    中添加原始html:

    :raw-html:`<h1>My Title</h1>`
    
    1. Section
    ================
    
    2. Section
    =================
    
    :原始html:`My Title`
    1.部分
    ================
    2.部分
    =================
    
    我使用
    解决了这个问题。。如上所述的raw::html
    方法,稍加调整(避免破坏自动生成的TOC)。如前所述,如果您的文件仅包含
    。。原始::html
    标题,它将打破斯芬克斯自动生成的TOC。但是,如果使用
    。。原始::html
    并在其下方添加
    ----------------
    ,它不会显示在左侧导航上,也不会破坏TOC。 e、 g

    因此,我终于意外地想出了如何使标题不显示在左侧的TOC中。如果您的文件仅包含
    。。原始::html
    h2标题,它将打破sphinx自动生成的TOC(如stackoverflow文章所述)。但是,如果使用
    。。原始::html
    ----------------
    在其下方,它不会显示在左侧导航上,也不会破坏TOC:star2: e、 g

    。。原始::html
    我可以用KSQL做什么?
    ---------------------
    
    您可以制作自己的h3标签

    对于标题,您可以使用:

    |start-h3| My title |end-h3|
    
    稍后在您编写的文件末尾:

    .. |start-h3| raw:: html
    
         <h3>
    
    .. |end-h3| raw:: html
    
         </h3>
    
    |start-h3 | raw::html
    .. |end-h3 | raw::html
    
    您似乎在谈论本地TOC(“本页”TOC)。不幸的是,Sphinx总是将文档标题打印为第一项(
  • )。实际的本地TOC(章节标题)都嵌套在第一个文档标题
  • 中。(是的,这很烦人。)

    您有两个选择:

    如果当前Sphinx主题具有本地TOC,则必须调整生成的HTML标记。例如,通过使用CSS隐藏文档标题。从以下位置复制粘贴:


    关于如何修改
    localtoc.html
    以删除显示的标题的任何建议…我似乎无法仅从文档中理解它…感谢您的帮助我看不出您将如何使用localtoc.html。这仅仅包含一个标题和对{{toc}}的调用。这会破坏toc树(如果您正在使用它),这也会破坏{toctree()}}(如果您正在使用它)。如果我们无法访问文档的内容(例如;
    。include::x
    ),该怎么办?你认为还有解决办法吗。我觉得很奇怪斯芬克斯把标题和全球目录树混在一起。谢谢你的帖子。实际上,当我省略
    --
    时,我没有收到任何错误。
    .. |start-h3| raw:: html
    
         <h3>
    
    .. |end-h3| raw:: html
    
         </h3>
    
    .localtoc > ul {
      margin: 0;
    }
    .localtoc > ul > li {
      list-style-type: none;
    }
    .localtoc > ul > li > a {
      display: none;
    }
    .localtoc > ul > li > ul {
      // any additional styles to local toc <ul>
    }
    
    #################################
    Contents without a document title
    #################################
    
    Testing ``contents::`` directive with ``:local:`` flag.
    
    .. contents::
       :local:
    
    **********
    Section L2
    **********
    
    Section L3
    ==========