GitHub पेज पर स्फिंक्स प्रलेखन

GitHub Pages एक ऐसी शांत सीजोफ्रेनिक चीज़ है जो a) बिल्ट-इन एडिटर का उपयोग करके बनाए गए पेज को प्रदर्शित कर सकती है, b) एक Jekyll ब्लॉग उत्पन्न करती है और c) मनमाने ढंग से डोमेन पर html फाइल प्रदर्शित करती है।
अंतिम छवि में, वह Sphinx का उपयोग करके लिखित दस्तावेज़ पोस्ट करने के लिए हमारे लिए इच्छुक है।

तकनीकी रूप से, किसी भी स्थिति में, gh-pages शाखा ( छोड़कर ) बनाई जाती है, जिसमें से सामग्री प्रदर्शित होती है।
तो, परियोजना एक भंडार है, इसके लिए प्रलेखन एक और है, यह उन्हें मिश्रण करने के लिए कोई मतलब नहीं है।
master डॉक्यूमेंट रिपॉजिटरी में, हम रीस्ट्रक्टेक्टेड टैक्स्ट फॉर्मेट और कॉन्फ़िगरेशन फाइलों में स्रोतों को बदलाव के इतिहास के साथ स्टोर करते हैं। gh-pages न केवल इतिहास निरर्थक है, बल्कि तार्किक रूप से यह शाखा master समानांतर भी मौजूद है। मैं निम्नलिखित लिपि बनाकर ऐसे परिसर से आगे बढ़ा।

 #!/bin/sh shopt -s extglob dotglob CURR_DIR="$(pwd)" TMP_DIR="$CURR_DIR"-gh-pages sh build.sh rm -rf "$TMP_DIR" cp -r . "$TMP_DIR" cd "$TMP_DIR" git branch -D gh-pages git checkout --orphan gh-pages rm -rf !(.git|.gitignore) cp -r "$CURR_DIR"/_build/html/* . touch .nojekyll echo "droidparts.org" > CNAME git add -A git commit -m "published" git push origin :gh-pages git push origin gh-pages rm -rf "$TMP_DIR" 

( लिंक )

क्रियाओं का क्रम:

1. उस स्क्रिप्ट को चलाएं जो दस्तावेज़ीकरण एकत्र करती है।
2. अस्थायी फ़ोल्डर में रिपॉजिटरी को कॉपी करें, उस पर जाएं।
3. gh-pages हटाएं, इसे फिर से बनाएं। - पैरेंट कमिट के बिना ब्रांच --orphan के लिए - --orphan पैरामीटर जिम्मेदार है। यानी आवश्यकता के अनुसार, master लिए बाध्य किए बिना। फ़ोल्डर को भी साफ़ करें।
4. हम पहले चरण में उत्पन्न फ़ाइलों की प्रतिलिपि बनाते हैं।
5. .nojekyll जोड़ें ताकि GitHub Pages Jekyll को फ़ोल्डर्स को रेखांकित करने की अनुमति न दे।
6. डोमेन के साथ एक CNAME फ़ाइल बनाएं जिसमें से सब कुछ दिया जाएगा। स्वाभाविक रूप से, आपको DNS को कॉन्फ़िगर करने की भी आवश्यकता है।
7. अंत में, कमिट करें, सर्वर से gh-pages हटाएं, पुश करें।

बोनस के रूप में, हम एक बग का निरीक्षण करते हैं जब गिटहब आगे और पीछे आने की संख्या की रिपोर्ट करता है , और जब इसकी तुलना करने की कोशिश करता है कि रिपोर्ट ...। या होना चाहिए?