আপনার পাইথন প্রকল্পটি স্পিনক্স এবং রিনোহাইটাইপের সাথে নথিভুক্ত করার জন্য একটি সহজ টিউটোরিয়াল

ডকুমেন্টিং কোড এমন একটি জিনিস যা আমি সত্যিই করতে চাই না তবে আমি গ্রেড স্তরের জন্য যাইহোক এটি করব।

আপনি যখন আমার প্রথম বছর কম্পিউটার বিজ্ঞান অধ্যয়ন করছিলেন তখন আপনার কাছ থেকে সম্ভবত এটি শুনতে পাবেন। কোডটি নথিভুক্ত করাতে আমি বিরক্তিকর এবং অকেজো বলে মনে করেছি কারণ আমার কোডটি কী করছে তা আমি ইতিমধ্যে জানি এবং এটি পড়ার সম্ভাবনা একমাত্র ব্যক্তি হলেন অধ্যাপক যিনি এটি পর্যালোচনা করেন।

আমি বহু বছর আগে রেফারেন্সের জন্য আমি যে অনিবন্ধিত কোডটি লিখেছিলাম তার দিকে তাকানোর আগে পর্যন্ত আমি এর অর্থ বুঝতে পারি নি এবং কেবল এটির পিছনে উল্টানোর পরিবর্তে আমি কীভাবে প্রকল্পটি কাঠামোগত গঠন করেছি এবং এমনকি এটি সম্পর্কে বেশ বিভ্রান্ত হয়ে অনেক সময় ব্যয় করেছি কিভাবে এটি চালানো।

আমাদের ডকুমেন্ট কোডে সহায়তা করার জন্য আজ সেখানে অনেকগুলি সরঞ্জাম রয়েছে। আমি সম্প্রতি এমন সরঞ্জামগুলি জানতে পেরেছি যা বুদ্ধিমান এবং আকর্ষক ডকুমেন্টেশন তৈরি করা সহজ করে। এর মধ্যে দুটি হ'ল স্পিনক্স এবং রিনোহাইটেপ।

জর্জ ব্র্যান্ডল দ্বারা রচিত এবং বিএসডি লাইসেন্সের আওতায় লাইসেন্সযুক্ত স্পিনেক্সটি মূলত পাইথন ডকুমেন্টেশনের জন্য তৈরি হয়েছিল এবং বিভিন্ন ভাষায় সফ্টওয়্যার প্রকল্পের ডকুমেন্টিংয়ের জন্য দুর্দান্ত বিকল্প রয়েছে (স্পিংক্স- ডক.অর্গ.২০১।)।

স্পিনিক্সের সাথে জুটিবদ্ধ রিনোহাইটেপ লটেক্সের একটি আধুনিক বিকল্প সরবরাহ করে। এটি একটি স্পিনিক্স ব্যাকএন্ড অফার করে যা আপনি পেশাদারভাবে পিডিএফ ডকুমেন্টস (ম্যাচিলস) তৈরি করতে ব্যবহার করতে পারেন।

এই টিউটোরিয়ালে, আমি একটি সহজ এপিআই প্রকল্পের জন্য এইচটিএমএল এবং পিডিএফ ডকুমেন্টেশন ফাইলগুলি তৈরি করতে স্পিনিক্স এবং রিনোহাইটাইপ ব্যবহার করছি যা শিক্ষক রেকর্ডের (গিথুব প্রকল্পের লিঙ্ক) একটি তালিকা বজায় রাখে।

  1. প্রকল্পটি ক্লোন করুন এবং ডক্স ফোল্ডারটি মুছুন / সরান যাতে আমি নতুন ডকুমেন্টেশন তৈরি করার সময় আপনি আমাকে অনুসরণ করতে পারেন।
  2. প্রকল্পের মূল ডিরেক্টরিতে পরিবর্তন করুন।
  3. পাইথন 3 ভার্চুয়াল পরিবেশ তৈরি এবং সক্রিয় করুন
ভার্চুয়ালেনভ-পি পাইথন 3 উৎস / বিন / সক্রিয় করা
এখানে আমি আমার ভার্চুয়াল পরিবেশের নাম রেখেছি

৪. সমস্ত প্রকল্পের প্রয়োজনীয়তা ইনস্টল করুন

পাইপ ইনস্টল করুন -r প্রয়োজনীয়তা। txt

দ্রষ্টব্য: স্ফিংকস এবং রিনোহাইটেপ ইতিমধ্যে প্রয়োজনীয়তা.টিএসটি ফাইলের মধ্যে রয়েছে। আপনি বর্তমানে যে প্রকল্পটির কাজ করছেন তার ভার্চুয়াল পরিবেশে সেগুলি ইনস্টল করতে চাইলে নীচের কমান্ডগুলি ব্যবহার করুন।

পাইপ স্পিংস পাইপ ইনস্টল করুন রিনো টাইপ pe

5. একটি ডকস ডিরেক্টরি তৈরি করুন এবং এই ডিরেক্টরিতে একটি সিডি রাখুন।

mkdir ডক্স সিডি ডকস্

6. স্ফিংস সেট আপ করুন

স্পিনিক্স দ্রুত শুরু
আপাতত এই কনফিগারেশন অনুসরণ করুন। আপনি নিজেই এটি পুনরায় কনফিগার করতে পারেন।আগের ছবিটির ধারাবাহিকতা

7. ওপেন সোর্স / কনফাই.পি

  • রুট ডিরেক্টরিতে পাথ কনফিগার করুন
মন্তব্য লাইন 15-17

পাথটি প্রকল্পের মূল ডিরেক্টরিতে নির্দেশ করা উচিত এবং প্রকল্পের কাঠামোটি দেখানো উচিত। কনফাই.পি থেকে আমাদের দুটি মূল ডিরেক্টরিতে গিয়ে মূল ডিরেক্টরিতে পৌঁছানো উচিত।

প্রকল্প কাঠামো
  • এক্সটেনশনের তালিকায় রিনোহাইটাইপ যুক্ত করুন
'রিনোহ.ফ্রন্টএন্ড.স্পিনেক্স'
  • ক্ষীরের উপাদানগুলি মন্তব্য করুন
এই মন্তব্যআপনি আরও ফর্ম্যাটটি পরিবর্তন করতে পারেন, এটি কেবলমাত্র ডিফল্ট সেটিংস।

৮. সূচি.আরস্ট ফাইলটি খুলুন এবং নিম্নলিখিত বিষয়বস্তু পরিবর্তন করুন। (এর সমস্ত বিষয়বস্তু দেখার জন্য সূচি.প্রথম লিঙ্কটি ক্লিক করুন।)

কোডের জন্য ডকুমেন্টেশন ************************** .. ট্যাক্ট্রি ::: ম্যাক্সডেপথ: 2: ক্যাপশন: বিষয়বস্তু: টিচারাপি প্রধান ===== ============= .. অটোমোডুল :: অ্যাপ: সদস্য: টিচারাপিআই-কন্ট্রোলার =================== .. অটোমোডুল :: শিক্ষকAPI.controller: সদস্যগণ: শিক্ষকAPI মডেলগুলি ================ .. অটোমোডুল :: শিক্ষকAPI.models: সদস্য: শিক্ষকAPI ডাটাবেস ========== ======== .. অটোমোডুল :: শিক্ষকএপিআই.ড্যাটাবেস: সদস্য: টিচারাপিআই ================= .. অটোমোডুল :: শিক্ষকএপিআই.পপুলেট: সদস্যগণ :

9. এইচটিএমএল এবং পিডিএফ ডকুমেন্টেশন ফাইলগুলি তৈরি করুন।

  • এখনও ডক্স ডিরেক্টরিতে চলছে running
এইচটিএমএল স্পিনিক্স-বিল্ড-বি রিনোহ উত্স _ বিল্ড / রিনোহ তৈরি করে

সম্পাদনা দ্রষ্টব্য [16। মার্চ 2019]: আপনার পাইথন সংস্করণ যদি .73.7.0 হয় তবে পিডিএফ ফাইলটি তৈরি করতে ব্যর্থ হবে (গিথুব সমস্যার উল্লেখ)

প্রথম লাইনটি ডক্স / বিল্ড / এইচটিএমএল / সূচক html এ এইচটিএমএল ফাইল তৈরি করবে

Index.html এর দেখুন ofIndex.html এর দেখুন of

দ্বিতীয় লাইনে পিডিএফ ফাইলটি ডক্স / _ বিল্ড / রিনোহ / সিম্পলটিচারার ডেটাপিআই.পিডিএফ-এ তৈরি করা হয়

ডকুমেন্টেশন কভারসুচিপত্রডকুমেন্টেশন নমুনা পৃষ্ঠা

টিম প্রকল্পগুলিতে অভিজ্ঞতা অর্জনের পরে, আমি কোডটি কীভাবে ডকুমেন্ট করব তা বুঝতে শুরু করি। যদিও আমি বলব না এটি সবচেয়ে মজাদার কাজ, এটি অবশ্যই নির্ভরযোগ্য এবং প্রোগ্রামারদের দ্বারা এটি করা উচিত অনুশীলন করা।

স্পিনক্স সম্পর্কে আরও জানতে:

  • ওভারভিউ - স্পিনেক্স 1.8.0+ এর জন্য ডকুমেন্টেশন

অন্যান্য দরকারী টিউটোরিয়াল:

  • আপনার প্রকল্পটি স্ফিংক্স ব্যবহার করে ডকুমেন্টিং - এটি পাইথন ডকস্টাস্টিংগুলি ব্যবহার করে কীভাবে আমার কোডটি নথিভুক্ত করবেন তা বুঝতে সহায়তা করে।
  • ব্র্যান্ডনের স্পিনিক্স টিউটোরিয়াল - স্পিনক্স কীভাবে ব্যবহার করতে হবে তার বিস্তৃত টিউটোরিয়াল

ম্যাচিলস, ব্রেচেট "রিনোহটাইপ: পাইথন ডকুমেন্ট প্রসেসর - রিনোহাইপ টাইপ ০.০.১.ডেভ0 ডকুমেন্টেশন।" রিনোহটিপ.ড্রেথডেডকস.আইও। এনপি, 2016. ওয়েব। 17 ই জুন 2018।

স্পিনেক্স- ডক.অর্গ। (2018)। ওভারভিউ - স্পিনেক্স 1.8.0+ এর জন্য ডকুমেন্টেশন। [অনলাইন] এখানে উপলভ্য: http://www.sphinx-doc.org/en/master/ [জুন 17, 2018 এ দেখা হয়েছে]।