VHS'leri belgeler için Sphinx'i kullanırken göz ardı etmemeleri için hangi dosyaları söylemeliyim?

Question

Projemi belgelemek için Sphinx'u kullanmaya başlamak istiyorum. Sphinx'e sphinx-quickstart numaralı telefondan ayrı kaynak kullanıp dizinleri oluşturmasını söyledim. Şimdi benim dizin düzeni şudur: dosyalar Sfenks projesi (ı Git kullandığından yani, benim .gitignore dosyaya ne eklemek gerekir) için bir VCS deposundan dışında tutulmalıdır

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

? Örneğin, docs/build/ dizinini dikkate almamalıyım, böylece Sphinx'ten oluşturulan HTML sayfalarındaki değişiklikler izlenmez mi? Bu make clean sadece içeriğini görmezden, sürüm kontrolü açısından, bu nedenle build dizini kaldırır demektir

BUILDDIR  = build 

... 

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

: Eğer Makefile içeriğine bakmak aşağıdaki gibi

Answer 1

Eğer bir şey görürsünüz build dizini, şüphelendiğiniz kadar yeterli olmalıdır.

Answer 2

GitHub'da yeni bir proje oluşturursanız, sizin için bir Python aromalı .gitignore dosyası oluşturmayı önerir. Bu dosya Sfenks oluşturulan dosyalara one reference içerir:

# Sphinx documentation 
docs/_build/ 

Not: Bu sphinx-quickstart çalıştırdığınızda varsayılan değerleri kabul varsayar. Eğer bu sorulara cevap şekline göre ayarlamak gerekebilir:

1. Kök yolunu:

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

   Bu belgeler saklanır yolunu belirler. docs'dan başka bir şey yaptıysanız, .gitignore'u buna göre güncellemeniz gerekir.

2. Yapı dizini:

   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]: 
   

   Eğer n (varsayılan) yanıtı verdiyseniz, o zaman Sfenks <root>/_build tarafındaki derleme dizin oluşturacaktır (kaynak dosyaları <root>/ altında doğrudan saklanacaktır).

   y numaralı telefonu yanıtladıysanız, Sphinx <root>/build numaralı telefon dizinini oluşturacaktır (kaynak dosyalarınız <root>/source numaralı telefona kaydedilecektir).

   Önde gelen alt çizgi varlığını/yokluğunu not edin; .gitignore numaranızdaki karşılık gelen modelin eşleştiğinden emin olun.