স্পিংক্স সম্পর্কে আপনার প্রকল্পের জন্য একটি স্পিংক্স ডকুমেন্টেশন শেল তৈরি এবং উপস্থিত README ডকুমেন্টেশন সূচক হিসাবে ফাইল & nbsp অন্তর্ভুক্ত করা হবে যে একটি পাইথন হাতিয়ার;. এটা যেমন থেকে প্রকল্পের নাম, লেখক এবং সংস্করণের প্রয়োজন মেটা তথ্য আহরণের পরিচালনা আপনার আপনার স্পিংক্স ডক্স ব্যবহারের জন্য প্রকল্প.
আপনি ব্যবহার একবার স্পিংক্স সম্পর্কে আপনি তারপর পড়ুন দ্য ডক্স সাইটে আপনার প্রকল্প যোগ এবং আপনার প্রজেক্ট এর উপস্থিত README একটি আকর্ষণীয় স্পিংক্স ডকুমেন্টেশন থিম সঙ্গে আয়োজন করা থাকতে পারে, আপনার স্পিংক্স ডক্স গড়ে তুলতে.
দ্রষ্টব্য: আপনার README ফাইলের একটি reStructuredText সামঞ্জস্যপূর্ণ বিন্যাসে হওয়া আবশ্যক.
সংস্থাপনা
সবচেয়ে সহজ পদ্ধিতি হল উপায় ইনস্টল করার স্পিংক্স-আমাকে নীচে নিজ নিজ কমান্ড চালাতে পিপ বা setuptools ব্যবহার PyPI থেকে সরাসরি:
ইনস্টল বীচি -U স্পিংক্স সম্পর্কে
বা:
easy_install -U স্পিংক্স সম্পর্কে
অন্যথায় আপনি-আমার স্পিংক্স ডাউনলোড করতে পারেন এবং উৎস থেকে সরাসরি এটি ইনস্টল:
পাইথন ইনস্টল setup.py
চালনা
স্পিংক্স সম্পর্কে যখন আপনার প্রজেক্ট এর রুট ডিরেক্টরি কমান্ড-লাইন থেকে ব্যবহার করা যাবে যে একটি সিস্টেম ব্যাপী স্ক্রিপ্ট হিসাবে ইনস্টল করা হবে:
স্পিংক্স সম্পর্কে
আপনার প্রজেক্ট এর ডিরেক্টরির মধ্যে সঞ্চালিত হলে, দুটি ফাইল, স্পিংক্স conf.py মডিউল, এবং আপনার প্রজেক্ট এর উপস্থিত README অন্তর্ভুক্ত করা হবে, যা একটি index.rst ফাইল সঙ্গে একটি ডক্স ডিরেক্টরি তৈরি করবে.
conf.py মডিউল থেকে একটি সেটআপ ফাংশন কল স্পিংক্স সম্পর্কে আপনার স্পিংক্স ডক্স জন্য ন্যূনতম প্রয়োজনীয় সেটিংস সেট করে.
- প্রকল্প - আপনার প্রকল্প নির্দেশিকা নাম ব্যবহার করা হয়.
- সংস্করণ - আপনার setup.py স্ক্রিপ্ট, বা আপনার প্যাকেজ এর __version__ বৈশিষ্ট্য সংস্করণ ARG থেকে উদ্ধার করা হয়.
- কপিরাইট - আপনার setup.py স্ক্রিপ্ট, বা আপনার প্যাকেজ এর __author__ অ্যাট্রিবিউট লেখক ARG থেকে উদ্ধার
আবশ্যক
- . পাইথন
পাওয়া মন্তব্যসমূহ না