You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何让Sphinx API文档点击后直接展示AlloViz.Protein内容而非空白页

解决API导航直接跳转至Protein文档的方案

方法一:直接修改主目录toctree指向目标文档

在主index.rst的toctree中,将原本指向API/index的条目替换为直接指向生成的Protein文档路径,同时保留导航文字为“API reference”:

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   README
   API/generated/AlloViz.Protein   <--- 替换原有的API/index
   # 其他导航项

优点:操作最简单,直接跳过空白的API/index页面,点击导航直接进入Protein文档。
注意:如果需要保留API模块的完整层级(比如展示Delta等其他类),可以在Protein文档页面的toctree中添加其他API文档的链接,或者在侧边栏配置中补充。

方法二:重构API/index.rst,直接渲染Protein内容

修改API/index.rst,去掉空白内容,直接用autoclass指令渲染Protein类的完整文档,同时用隐藏toctree维护API其他文档的结构:

API Reference
=============

.. autoclass:: AlloViz.Protein
   :members:
   :undoc-members:
   :show-inheritance:
   :member-order: bysource

.. toctree::
   :hidden:
   :maxdepth: 2

   generated/AlloViz.Delta
   generated/AlloViz
   generated/AlloViz.Protein.calculate

优点:既满足点击“API reference”直接看到Protein内容,又能通过侧边栏或页面内链接访问其他API文档,避免include带来的重复警告和toctree继承问题。
依赖:确保numpydoc扩展已启用,能正确渲染类的文档格式。

方法三:使用Sphinx重定向功能

  1. 在conf.py中启用重定向扩展:
extensions = [
    # 其他已启用的扩展
    'sphinx.ext.redirects',
]
  1. 在API/index.rst顶部添加重定向指令,同时直接渲染Protein内容:
.. redirect-from:: /API/index.html

API Reference
=============

.. autoclass:: AlloViz.Protein
   :members:
   :undoc-members:
   :show-inheritance:

优点:既处理了旧的API/index.html路径跳转,又直接展示目标内容,适合需要兼容旧链接的场景。


内容的提问来源于stack exchange,提问作者Francho Nerín Fonz

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.08.24 07:24:19