كيفية تحميل وثائق HTML التي تم إنشاؤها من sphinx إلى github؟

Question

لقد قمت للتو بتوثيق الأحمال من الكود الخاص بي وتعلمت كيفية استخدام sphinx لإنشاء الوثائق. أريد أن أدرج ذلك في صفحة مشروع GitHub ولكن لا أعرف كيف. هل يعرف أي شخص البرنامج التعليمي الحالي أو خطوة بسيطة للقيام بذلك؟

شكرًا.

Answer 1

سيقدم Github محتوى ثابتًا لك باستخدامها صفحات جيثب خاصية. في الأساس ، يمكنك إنشاء فرع يسمى صفحات GH ، والتي ترتكب صفحاتك الثابتة. ثم يتم تقديم الصفحات عليك. github.com/yourproject.

انظر التعليمات في http://pages.github.com/.

من المحتمل أن تواجه مشكلة باستخدام sphinx على Github ، لأن Sphinx يستخدم الدلائل مع السفلية الرائدة. يمكنك إصلاح هذا عن طريق إضافة ملف يسمى .nojekyll في الدليل مع sphinx المتولد HTML.

Answer 2

إجابة يوحنا بوليت من الواضح أنه صحيح ومن المحتمل أن يكون كافيًا لمعظم المستخدمين بالفعل (+1).

بدلاً من ذلك قد ترغب في التحقق من البرنامج التعليمي الشامل لبن ويلش وثائق sphinx على جيثب, ، والتي توفر تعليمات خطوة بخطوة وكذلك مريحة قماش البرنامج النصي/المهمة المستند إلى ربط هؤلاء معًا لتبدأ في ذلك نشر الوثائق بسرعة إلى جانب الكود الخاص بك [... عبر أمر واحد.

Answer 3

جيثب أدوات لديه ميزة تفعل بالضبط ما تطلبه:

paver gh_pages_create gh_pages_build

الرجوع إلى وثائق ممتازة (بالطبع باستخدام نفسه) لكيفية إعداده لمشروعك.