在sphinx.ext.autosummary中隐藏侧边栏中的目录,可以通过以下步骤实现:
conf.py
文件中,添加以下配置:autosummary_generate = False
这将阻止Sphinx自动生成autosummary页面。
.. autosummary::
:toctree: <path-to-hidden-toctree-file>
module.function
module.Class
这里<path-to-hidden-toctree-file>
是指向隐藏目录的toctree文件的相对路径。
hidden.rst
),在其中指定要隐藏的目录结构。例如:.. toctree::
:hidden:
module/index
another_module/index
...
这将隐藏指定的模块及其子模块。
需要注意的是,以上步骤是基于sphinx.ext.autosummary扩展进行的。autosummary是用于自动生成API文档的工具,它可以根据代码中的注释生成摘要和文档页面。通过以上步骤,你可以在使用autosummary生成文档时,隐藏侧边栏中的目录。
关于Sphinx和autosummary的更多信息,请参考腾讯云文档中以下链接:
请注意,本回答仅提供了解决问题的一种方法,可能还有其他的方式来隐藏侧边栏中的目录,具体解决方案可能因你的项目结构和需求而有所不同。
领取专属 10元无门槛券
手把手带您无忧上云