python - Sphinx 不会为标题生成侧边栏目录

Question

我正在努力处理 Sphinx 生成的文档中的侧边栏目录。

我只想在我的文档左侧有一种自动生成的索引树。相反，我只看到空白标题: (我希望你不介意目标文档是波兰语)

我的 index.rst 文件:

.. SIMail documentation master file, created by
   sphinx-quickstart on Mon Nov 26 12:38:31 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to SIMail docs!
=======================

.. toctree::
   :numbered:

Providers
==============

.. automodule:: Providers
   :members:

Connection managers
===================

.. automodule:: ConnectionManagers
   :members:


Indices and tables
******************

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

我的 conf.py 文件:

# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('../../src'))


# -- Project information -----------------------------------------------------

project = 'SIMail'
copyright = '2018, Kamil Kurzacz'
author = 'Kamil Kurzacz'

# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = '1'


# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
    'sphinx.ext.githubpages',
    'sphinx.ext.autosummary',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
#language = 'pl'
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'SIMaildoc'


# -- Options for LaTeX output ------------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').

    'papersize': 'a4paper',

    # The font size ('10pt', '11pt' or '12pt').

    'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.

    'preamble': '',

    # Latex figure (float) alignment

    'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'SIMail.tex', 'SIMail Documentation',
     'Kamil Kurzacz', 'manual'),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'simail', 'SIMail Documentation',
     [author], 1)
]


# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'SIMail', 'SIMail Documentation',
     author, 'SIMail', 'One line description of project.',
     'Miscellaneous'),
]


# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']


# -- Extension configuration -------------------------------------------------

# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

# -- Options for autogenerate
autodoc_default_flags = ['members']
autosummary_generate = True

我一直在寻找诸如“Sphinx 不在侧边栏上生成索引”之类的问题，但我一无所获。看起来我忽略了一些小细节。 reST 中是否有特殊命令强制 Sphinx 在侧边栏上生成索引列表？

我找到了我的问题的部分答案，即使用 sphinx-autodoc 为所有模块生成单独的文件.但看起来问题是 Sphinx 在从 index.rst 构建目录时忽略了所有 header

简而言之，我想要在我的 index.rst 中包含指向所有标题的链接的导航列表，与此 tutorial example 中的方式相同.作者似乎只放置了带有源文件的部分。他已经自动生成了指向 index.rst 中所有标题的导航。为了显示我的问题，我附上另一张图片: 请看example's index.rst .文件中存在的每个标题都在导航中生成了链接。

2018-12-17更新

我已关注问题的评论，并将 Sphinx 手动升级到 v2.0.0+/60e3c2a。仍然无法得到我需要的东西。我所做的是:

1. Git 克隆 https://github.com/sphinx-doc/sphinx
2. cd 到带有新 sphinx 的目录，然后 python setup.py 构建并安装我还需要做其他事情吗？

这是我从 Sphinx 的输出:

>make html
Running Sphinx v2.0.0+/60e3c2a
loading translations [en]... done
c:\users\kamil\appdata\local\programs\python\python37-32\lib\site-packages\sphinx-2.0.0.dev20181217-py3.7.egg\sphinx\events.py:77: RemovedInSphinx30Warning: autodoc_default_flags is now deprecated. Please use autodoc_default_options instead.
  results.append(callback(*args))
loading pickled environment... done
[autosummary] generating autosummary for: index.rst
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 0 changed, 6 removed
looking for now-outdated files... none found
no targets are out of date.
build succeeded.

The HTML pages are in build\html.

Answer 1

您需要为 Alabaster 主题添加一个明确的 html_sidebars 设置，根据其 documentation :

Either way, add an explicit html_sidebars setting so Alabaster’s customized sidebar templates are loaded:

    html_sidebars = {
        '**': [
            'about.html',
            'navigation.html',
            'relations.html',
            'searchbox.html',
            'donate.html',
        ]
    }