स्पष्टीकरण के लिए स्फिंक्स का उपयोग करते समय मुझे कौन सी फाइलों को अनदेखा करना चाहिए?

Question

मैं अपने प्रोजेक्ट को दस्तावेज करने के लिए Sphinx का उपयोग शुरू करना चाहता हूं। मैंने स्पिंक्स को अलग स्रोत का उपयोग करने और sphinx-quickstart के दौरान निर्देशिका बनाने के लिए कहा। अब मेरी निर्देशिका लेआउट निम्नलिखित है:

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

कौन सा फ़ाइलें एक स्फिंक्स परियोजना (जैसे कि, के बाद से मैं Git का उपयोग करें, क्या मैं अपने .gitignore फ़ाइल में जोड़ना चाहिए) के लिए एक VCS रिपोजिटरी से बाहर रखा जाना चाहिए? उदाहरण के लिए, क्या मुझे docs/build/ निर्देशिका को अनदेखा करना चाहिए ताकि स्फिंक्स से उत्पन्न HTML पृष्ठों में परिवर्तन ट्रैक न किए जाएं?

BUILDDIR  = build 

... 

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

इसका मतलब है कि make clean सिर्फ संस्करण नियंत्रण के संबंध में तो build निर्देशिका निकाल देता है, की सामग्री को अनदेखी:

Answer 1

आप Makefile की सामग्री पर एक नज़र डालें तो इस प्रकार आप कुछ दिखाई देगा build निर्देशिका पर्याप्त होनी चाहिए जैसा कि आप पहले ही संदेह कर चुके हैं।

Answer 2

यदि आप गिटहब पर एक नई परियोजना बनाते हैं, तो यह आपके लिए पाइथन-स्वादयुक्त .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>/_build पर पैदा करेगा (अपने स्रोत फ़ाइलों <root>/ के तहत सीधे संग्रहीत किया जाएगा)।

   यदि आपने y का उत्तर दिया है, तो स्पिंक्स <root>/build पर निर्माण निर्देशिका बनाएगा (आपकी स्रोत फ़ाइलों को <root>/source में संग्रहीत किया जाएगा)।

   अग्रणी अंडरस्कोर की उपस्थिति/अनुपस्थिति पर ध्यान दें; सुनिश्चित करें कि आपके .gitignore मैचों में संबंधित पैटर्न।