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

Я искал вопросы типа "Сфинкс не генерирует индексы на боковой панели", но ничего не нашел.Похоже, я опустил мелкие детали.Есть ли в reST специальная команда, чтобы заставить Sphinx генерировать список индексов на боковой панели?

Я нашел частичный ответ на мой вопрос, который заключается в создании отдельных файлов для всех модулей с sphinx-autodoc ,Но, похоже, проблема в том, что Sphinx игнорирует все заголовки, когда речь идет о создании оглавления из index.rst

Проще говоря, я хочу иметь список навигации со ссылками на все заголовки вмой index.rst, так же, как в этом учебном примере .Автор, кажется, поместил почти ничего, кроме разделов с исходными файлами.И он автоматически сгенерировал навигацию по всем заголовкам в index.rst.Чтобы показать мою проблему, я прилагаю другое изображение: Пожалуйста, посмотрите на пример index.rst .Каждый заголовок, существующий в файле, имеет сгенерированную ссылку в навигации.

2018-12-17 update

Я следил за комментариями к проблеме и вручную обновил Sphinx до v2.0,0 + / 60e3c2a.Все еще не могу получить то, что мне нужно.Я сделал следующее:

Git clone https://github.com/sphinx-doc/sphinx
cd в каталог с новым sphinx, затем сборка и установка python setup.py Нужно ли делать что-то еще?

Это мой вывод Сфинкса:

>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.

Steve Piercy · Answer 1 · 12 декабря 2018

Вам необходимо добавить явную настройку для html_sidebars для темы Alabaster, согласно ее документации :

В любом случае, добавьте явную настройку html_sidebars, чтобы Alabaster'sзагружаются настраиваемые шаблоны боковой панели:

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

Sphinx не генерирует содержание боковой панели для заголовков

Пожалуйста, войдите или зарегистрируйтесь чтобы ответить на этот вопрос.

1 Ответ

Пожалуйста, войдите или зарегистрируйтесь что бы добавить комментарий.

Sphinx не генерирует содержание боковой панели для заголовков

Пожалуйста, войдите или зарегистрируйтесь чтобы ответить на этот вопрос.

1 Ответ

Пожалуйста, войдите или зарегистрируйтесь что бы добавить комментарий.

Похожие темы