readthedocs公開githubリポジトリからドキュメントを作成していません

Question

私は公開githubリポジトリを持っています。 readthedocsでinstructionsに続いて、私は他の人に見てもらえる形でドキュメントを入手するためにSphinxを使いました。

ファイルを編集し、表示されているものが好きになるまで再構築してから、変更をコミットして公開リポジトリにプッシュします。公開リポジトリにSphinxのドキュメントがあれば、Read the Docsを使うことができます。

私はすべてgithubの公開リポジトリにプッシュしました。特に、docs.pyとindex.rstというファイルがdocsにあります。これは私のプロジェクトのトップレベルにあるフォルダです。

私はreadthedocsで自分のアカウントを作成しました。 readthedocsにリポジトリの場所を教えました。私は今それが

あなたのコードは自動的にあなたの公開リポジトリから取得され、ドキュメントが構築されますがあります。

代わりに、readthedocsがそれを構築するように見えますが、私が見てみるとそこには何もありません。 Webページは存在しますが、ドキュメントはありません。私のコンピュータ上に構築された同じファイルがドキュメントを示しています。

ビルドからの出力は、readthedocs hereで確認できます。

関連するかもしれないもう一つの詳細は、それが主なコードがdocsが中に座っていることのディレクトリにあることを知っているように、私はgithubのでconf.pyファイルを編集しなければならなかったということですので、

- 。私がするには何が必要ですドキュメントを正しく作成するためにreadthedocsを取得するように変更します。さらに重要なことは、私が誤解したことは何ですか？

Answer 1

RTDは、モジュールによってインポートされたモジュールを見つけることができません。 https://readthedocs.org/projects/epidemicsonnetworks/builds/5247491/

したがって、モジュールを見つけるためにRTDを構成するまで、RTDでドキュメントを作成するためにローカルで行うことはできません。 FAQ that covers this issueがあります。

ピラミッドの場合、setup.pyがあり、-e .[docs]というコマンドをプロジェクトのルートレベルのrtd.txtというファイルに入れます。その後、我々は、[詳細設定]の下で、RTDは、このファイルを使用するように設定します。

• ダニを
• 要件ファイルの名前を入力し、「setup.py installを使用してvirtualenvの内部で、プロジェクトをインストールします」。

スクリーンショットを参照してください。