toctreeエントリを追加するには

Question

私はPythonを文書化するためにSphinxを始めようとしています。始めにいくつかの非常に基本的なステップが欠けているようです。

私はhttp://www.sphinx-doc.org/en/stable/tutorial.htmlに従っており、可能であればデフォルトでツールをインストールして設定しています。

問題は、インデックスに別のRSTファイルをリンクできないことです。私のインデックスファイルは以下の通りです：intro.rst以下の内容で同じディレクトリにある

Welcome to FirstProject's documentation! 
==================================== 
.. toctree:: 
    :maxdepth: 2 

intro 

注：

Introduction to the FirstProject project!! 
====================================== 

.. toctree:: 
    :maxdepth: 2 

出力タイプはhtmlです。私は

make html 

をしようとすると私は警告が言ってもらう：

/home/ngk/Code/Projects/Twitter/botscore/doc/intro.rst: WARNING: document isn't included in any toctree 

が、私は「イントロ」文字列でハイパーリンクがイントロを指すリンクでのindex.htmlに作成されることを期待しました。 html

代わりに、index.htmlファイルの予想される場所に「intro」という文字列があります。 intro.htmlファイルは作成されていますが、index.htmlからハイパーリンクされていないことに注意してください。

誰かが私が見逃したような小さなステップを提案できますか？

Answer 1

Sphinx-docは、含まれているRSTの各行の先頭に3つの空白が必要だったようです。 index.rstを次のように変更すると、問題が解決しました！

.. toctree:: 
    :maxdepth: 2 

    intro 

Sphinx-docは、空白の正確な数に敏感であるようです。私は少数を使ってみましたが、タブスペースを使ってみましたが、どちらもうまくいきませんでした。

これは、この問題に遭遇した他の人にとって役に立ちます。

編集： それは限りtoctree内の各エントリは空白の同じ番号を持っているとして、あまりにも空白他の数で動作します。