Can I remove the quot;srcquot; package from python doc generated with sphinx?(我可以从用Shinx生成的python文档中删除quot；srcquot；包吗？)

本文介绍了我可以从用Shinx生成的python文档中删除&quot；src&quot；包吗？的处理方法，对大家解决问题具有一定的参考价值，需要的朋友们下面随着小编来一起学习吧！

问题描述

我有一个python项目和如下所示的结构 

project
|-- doc
|-- src
    |-- mod_1.py
    |   |-- Class1    
    |-- package1
        |-- mod_2.py
            |-- Class2

我使用sphinx-apidoc创建我的文档，我的子模块的路径如下所示

src.mod1
src.package2.mod2
现在我想知道，是否有方法可以删除src前缀？ 要使路径看起来像这样

mod1
package2.mod2

推荐答案

在giHubsphinx #3113提出问题后，shimizukawa提出了解决方案：

  • 从src文件夹中删除__init__.py
  • 在conf.py
    • 中将pythonpath设置为/../src，而不是/../

这篇关于我可以从用Shinx生成的python文档中删除&quot；src&quot；包吗？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持编程学习网！