我可以从使用 sphinx 生成的 python 文档中删除 "src" 包吗?
Can I remove the "src" package from python doc generated with 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
在 GitHub sphinx #3113 提出问题后,shimizukawa 提出了解决方案:
- 从
src
文件夹中删除 __init__.py
- 在
conf.py
中将 pythonpath 设置为 /../src
而不是 /../
我有一个 python 项目和这样的结构
project
|-- doc
|-- src
|-- mod_1.py
| |-- Class1
|-- package1
|-- mod_2.py
|-- Class2
我使用 sphinx-apidoc
创建我的文档,我的子模块的路径如下所示
src.mod1
src.package2.mod2
现在想知道有没有办法把src
前缀去掉?
使路径看起来像这样
mod1
package2.mod2
在 GitHub sphinx #3113 提出问题后,shimizukawa 提出了解决方案:
- 从
src
文件夹中删除__init__.py
- 在
conf.py
中将 pythonpath 设置为
/../src
而不是 /../