6

モジュールを文書化するために ( and と組み合わせて) を使用しようとしていますが、基本的なセットアップの後、実行するsphinxと、docstrings が含まれていない基本的な html のみが生成されます。私は Python 3.3 を実行しています。プロジェクト構造の概要は次のとおりです。autodocnumpydocmake html

Kineticlib
|--docs
|  |--build
|  |--source
|  |  |--conf.py
|--src
|  |--kineticmulti
|  |  |--__init__.py
|  |  |--file1.py
|  |  |--file2.py
|--setup.py

__init__.py空で、追加conf.pyしたdocs/sourceディレクトリにありますsys.path.insert(0, os.path.abspath('../..'))

ディレクトリで実行make htmlするとdocs、次の出力が得られます。

sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v1.2.2
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
no targets are out of date.

Build finished. The HTML pages are in build/html.

それで、私は何を間違っていますか？

4

2 に答える 2

11

docs/source ディレクトリで sphinx-apidoc を実行しましたか? これにより、html の作成に使用される .rst ファイルが生成されます。からman sphinx-apidoc、

sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames ...]

(少なくとも) outputdir(.rst ファイルの場所、./ が機能するはず) と、sourcedirパッケージを指す必要がある (../../src/kineticmulti が機能するように見える) を含める必要があります。

于 2014-07-23T09:16:56.487 に答える