首页
学习
活动
专区
圈层
工具
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何在sphinx.ext.autosummary中隐藏侧边栏中的目录?

在sphinx.ext.autosummary中隐藏侧边栏中的目录,可以通过以下步骤实现:

  1. 在项目的conf.py文件中,添加以下配置:
代码语言:txt
复制
autosummary_generate = False

这将阻止Sphinx自动生成autosummary页面。

  1. 在需要隐藏侧边栏中目录的文档中,使用以下注释标记隐藏部分:
代码语言:txt
复制
.. autosummary::
   :toctree: <path-to-hidden-toctree-file>

   module.function
   module.Class

这里<path-to-hidden-toctree-file>是指向隐藏目录的toctree文件的相对路径。

  1. 创建一个新的toctree文件(比如hidden.rst),在其中指定要隐藏的目录结构。例如:
代码语言:txt
复制
.. toctree::
   :hidden:

   module/index
   another_module/index
   ...

这将隐藏指定的模块及其子模块。

需要注意的是,以上步骤是基于sphinx.ext.autosummary扩展进行的。autosummary是用于自动生成API文档的工具,它可以根据代码中的注释生成摘要和文档页面。通过以上步骤,你可以在使用autosummary生成文档时,隐藏侧边栏中的目录。

关于Sphinx和autosummary的更多信息,请参考腾讯云文档中以下链接:

请注意,本回答仅提供了解决问题的一种方法,可能还有其他的方式来隐藏侧边栏中的目录,具体解决方案可能因你的项目结构和需求而有所不同。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

没有搜到相关的文章

扫码

添加站长 进交流群

领取专属 10元无门槛券

手把手带您无忧上云

扫码加入开发者社群

热门标签

活动推荐

    运营活动

    活动名称
    广告关闭
    领券