sphinx-apidoc并不能找到所有python文件。

Question

我有以下两门课：

class Test1():
    """Test1()"""

    def fn_test1():
        """fn_test1 """
        print "Hello1"

。

class Test2():
    """Test2()"""

    def fn_test2():
        """fn_test2 """
        print "Hello2"

这些类存储在不同的文件夹中，如下所示：

$ tree -A
.
├── docs
│   ├── _build
│   ├── conf.py
│   ├── index.rst
│   ├── make.bat
│   ├── Makefile
│   ├── _static
│   ├── _templates
│   └── Test1.rst
└── src
    └── standard
        ├── test1
        │   └── Test1.py
        └── test2
            └── Test2.py

我试图运行sphinx，但是它只使用以下命令找到了Test1.rst：

$ sphinx-apidoc -f -A "Author" -H "Test project" -V "version 1.0" -R "release 2014" -F -d 4 -e -P -o docs /home/u/tmp/sphinx/src/standard/*
Creating file docs/Test1.rst.
Creating file docs/conf.py.
Creating file docs/index.rst.
Creating file docs/Makefile.
Creating file docs/make.bat.

如果我删除*它什么也找不到：

$ sphinx-apidoc -f -A "Author" -H "Test project" -V "version 1.0" -R "release 2014" -F -d 4 -e -P -o docs /home/u/tmp/sphinx/src/standard/
Creating file docs/conf.py. 
Creating file docs/index.rst.
Creating file docs/Makefile.
Creating file docs/make.bat.

如何能够调用sphinx来找到Test1.py和Test2.py？

Answer 1

Python打包依赖于目录树。因此，从您所做的工作来看，标准是一个包含两个“子包”( test1和test2 )的包。每个子包都包含一个模块，要么是Test1，要么是Test2。

必须将名为__init__.py的(可能)空文件添加到包含包的每个目录中，然后运行

sphinx-apidoc -f -A "Author" -H "Test project" -V "version 1.0" -R "release 2014" -F -d 4 -e -P -o docs /home/u/tmp/sphinx/src/standard/

没有*标志。