1
私はPythonプロジェクトのドキュメントを生成するためにSphinxを試しています。私は実際にそれを動作させることができることを確かめるために、私はそれを試してみるためにテストプロジェクトを作った：https://github.com/ThomasA/sphinxtest。私のPythonモジュールからsphinx-quickstart auto-includeドキュメントストリングを作る方法
私はこのリポジトリのルートにsphinx-quickstartを実行しました。以下の質問では、ドキュメンテーションルートとして「doc」を指定し、プロジェクト 'sphinxtest'に名前を付け、著者として「Thomas Arildsen」と入力し、「autodoc」オプションに「y」と回答し、その他すべてのデフォルト設定を選択しました。
'autodoc'オプションは、 'doc'フォルダに 'amodule.rst'というファイルを生成すると予想しました。しかし、これは生成されません。私はこれに困惑している。私はこれが「autodoc」オプションがやろうとしていたものだと思っていました。スフィンクスは何のエラーメッセージも出さずに完了します。そうすれば、スフィンクスは何をすべきかを考えているようです。だから、私は何が間違っていますか？
私は、すべてSynplify v。1.5.6とPython 3.5.3を使用していますが、すべてAnacondaとともにインストールされています。
グレート、私はまだ少し混乱しています： ' 'DOC/sphinxtest.rst' と 'のdoc/modules.rst' を生成する.' DOC -oスフィンクス-apidoc。私は他のプロジェクトで見たものに基づいて、「amodules.rst」も期待していました。 –
私は今それを理解したようです。私はconf.pyを編集して、モジュールを見つけるためのパスを追加し、実際にモジュールをドキュメントに含めるためにindex.rstを編集しなければならないことに気づいていませんでした。 –