我可以从sphinx生成的python doc中删除“src”包吗?

时间:2016-04-12 16:51:49

标签: python python-sphinx

我有一个python项目和这样的结构

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

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

src.mod1
src.package2.mod2

现在我想知道,如果有办法删除src前缀? 使路径看起来像这样

mod1
package2.mod2

1 个答案:

答案 0 :(得分:0)

在GitHub sphinx #3113提出问题后,shimizukawa想出了一个解决方案:

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