ドキュメントにSphinxを使用しているとき、VCSに無視するファイルを教えてください。

Question

Sphinxを使用してプロジェクトを文書化します。私はsphinx-quickstartの間に別のソースとビルドディレクトリを使うようにスフィンクスに語った。今私のディレクトリレイアウトは以下の通りです：

MyProject/ 
    myproject/ 
     __init__.py 
     mymodule.py 
    docs/ 
     source/ 
      .static/ 
      .templates/ 
      conf.py 
      index.rst 
     build/ 
     Makefile 

ファイルが（私はGitのを使用しているため、すなわち、私は私の.gitignoreファイルに追加する必要があります）SphinxのプロジェクトのためのVCSレポジトリから除外すべき？たとえば、docs/build/ディレクトリを無視すると、Sphinxから生成されたHTMLページの変更が追跡されませんか？

Answer 1

あなたがMakefileの内容を見てみる場合は、次のように何かが表示されます：

BUILDDIR  = build 

... 

clean: 
    -rm -rf $(BUILDDIR)/* 

これはmake cleanはただの内容を無視して、バージョン管理に関しては、そうbuildディレクトリを削除することを意味buildディレクトリは、すでに疑わしいほど十分なはずです。

Answer 2

GitHubで新しいプロジェクトを作成すると、Python風味の.gitignoreファイルが作成されます。このファイルには、スフィンクス、生成されたファイルにone referenceが含まれています

# Sphinx documentation 
docs/_build/ 

注：これは、あなたがsphinx-quickstartを実行するときは、デフォルトを受け入れることを前提としています。あなたはこれらの質問に答え方法に応じてそれを調整する必要があります。

1. ルートパス：

   を

   Enter the root path for documentation. 
   > Root path for the documentation [.]: 
   

   これは、ドキュメントが格納されているパスを決定します。 docs以外のものを作成した場合は、それに応じて.gitignoreを更新する必要があります。

2. ビルドディレクトリ：

   You have two options for placing the build directory for Sphinx output. 
   Either, you use a directory "_build" within the root path, or you separate 
   "source" and "build" directories within the root path. 
   > Separate source and build directories (y/n) [n]: 
   

   あなたはn（デフォルト）を答えた場合、その後、スフィンクスは（あなたのソースファイルが<root>/直下に保存されます）<root>/_buildでビルドディレクトリを作成します。

   yと答えた場合、スフィンクスは<root>/buildにビルドディレクトリを作成します（ソースファイルは<root>/sourceに保存されます）。

   先頭のアンダースコアの有無に注意してください。 .gitignoreの対応するパターンが一致することを確認してください。あなたは（http://sphinx-doc.org/man/sphinx-apidoc.html）[スフィンクス-apidoc]を使用している場合ということ