Sphinx rtd docs 下拉菜单仅适用 post 点击

Question

我使用 sphinx 和 sphinx_rtd_theme 为我的包创建了一个 rtd 主题文档。 index.rst如下：

Welcome!

.. toctree::
   :maxdepth: 1
   :glob:

   src


Indices and tables
==================

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

而src文件大致遵循这样的思路：

================
Template Project
================
.. automodule:: src
   :members:
   :undoc-members:
   :show-inheritance:

.. toctree::
   :maxdepth: 4

   features
   io
   model
   utilities

在conf.py中html_theme_options也如下：

html_theme_options = {
    "analytics_anonymize_ip": False,
    "logo_only": False,
    "display_version": True,
    "prev_next_buttons_location": "bottom",
    "style_external_links": False,
    "vcs_pageview_mode": "",
    # Toc options
    "collapse_navigation": True,
    "sticky_navigation": True,
    "navigation_depth": 4,
    "includehidden": True,
    "titles_only": False,
    "globaltoc_collapse": True,
    "globaltoc_maxdepth": None,
}

我现在遇到的问题是，下拉菜单无法正常工作。它们不会出现在侧边栏中，除非我单击一个附近应该有下拉按钮的项目。

点击侧边栏 link 后，我将转到下一个文件，这是一个打开的下拉菜单。

我想做的是，我希望从第一项开始就有下拉选项。这很笨重且不直观。

Answer 1

根据docs for the theme，可以设置collapse_navigation = False。

Sphinx rtd docs 下拉菜单仅适用 post 点击

Sphinx rtd docs dropdown only works post click

documentation

python-sphinx

documentation-generation

read-the-docs