প্রশ্ন ট্যাগ «python-sphinx»

স্পিঙ্কস এমন একটি সরঞ্জাম যা বুদ্ধিমান এবং সুন্দর ডকুমেন্টেশন তৈরি করা সহজ করে। স্পিনিক্স বিশেষ করে পাইথন ডকুমেন্টেশনের জন্য উপযুক্ত, তবে এটি একটি সাধারণ-উদ্দেশ্য সরঞ্জাম যা কোনও কিছু নথিভুক্ত করতে ব্যবহার করা যেতে পারে।


6
স্পিঙ্কস অটোডোক যথেষ্ট স্বয়ংক্রিয় নয় not
আমি পাইথনে একটি 5,000+ লাইন প্রকল্প নথিভুক্ত করতে স্পিনিক্স ব্যবহার করার চেষ্টা করছি। এটি প্রায় 7 বেস মডিউল আছে। আমি যতদূর জানি, অটোডোক ব্যবহার করার জন্য আমার প্রকল্পের প্রতিটি ফাইলের জন্য এই জাতীয় কোড লিখতে হবে: .. automodule:: mods.set.tests :members: :show-inheritance: এটি অনেক ক্লান্তিকর কারণ আমার অনেকগুলি ফাইল রয়েছে। এটি …

3
অন্য পৃষ্ঠায় একটি উপ-শিরোনাম বা অ্যাঙ্করকে ক্রস-রেফারেন্স যুক্ত করা
একই ডকুমেন্টেশন সেটে অন্য পৃষ্ঠায় উপ-শিরোনাম বা অ্যাঙ্করকে কোনও পুনর্নির্মাণ / স্পিনিক্স পৃষ্ঠায় একটি ক্রস-রেফারেন্স কীভাবে সন্নিবেশ করবেন?

7
স্ফিংস-বিল্ড ব্যর্থ - অটোডোক মডিউল আমদানি / সন্ধান করতে পারে না
আমি স্পিনক্সের সাথে শুরু করার চেষ্টা করছি এবং মনে হচ্ছে অবিরাম সমস্যা আছে। আদেশ: docs/sphinx-quickstart আমি সমস্ত প্রশ্নের উত্তর দিই এবং সবকিছু ঠিকঠাক কাজ করে। আদেশ: docs/ls সবকিছু স্বাভাবিক দেখাচ্ছে। ফলাফল:build Makefile source আদেশ: sphinx-build -d build/doctrees source build/html মনে হচ্ছে এটি কাজ করে। আমি সূচক html ফাইল খুলতে এবং …

5
কোনও শ্রেণীর __init __ (স্ব) পদ্ধতি নথির জন্য কীভাবে স্পিনাক্সের অটোডোক ব্যবহার করবেন?
স্পিনিক্স ডিফল্টরূপে __init __ (স্ব) এর জন্য ডক্স তৈরি করে না। আমি নিম্নলিখিত চেষ্টা করেছি: .. automodule:: mymodule :members: এবং ..autoclass:: MyClass :members: কনফাই.পি-তে, নিম্নলিখিতগুলি সেট করা কেবলমাত্র ক্লাসের ডক্ট্রিং-এর সাথে __init __ (স্ব) ডাস্ট্রিং যুক্ত করে ( স্পিনিক্স অটোডোক ডকুমেন্টেশন সম্মত বলে মনে হয় যে এটি প্রত্যাশিত আচরণ, তবে …

7
** কাওয়ারস প্যারামিটার নথিভুক্ত করার সঠিক উপায় কী?
আমি আমার পাইথন মডিউলগুলির জন্য API ডকুমেন্টেশন জেনার জন্য স্ফিংস এবং অটোডোক প্লাগইন ব্যবহার করছি । সুনির্দিষ্টভাবে নির্দিষ্ট পরামিতিগুলি কীভাবে ডকুমেন্ট করা যায় তা আমি দেখতে পেলাম, প্যারামিটারটি কীভাবে ডকুমেন্ট করব তার উদাহরণ আমি পাই না **kwargs। এগুলি নথিভুক্ত করার সুস্পষ্ট উপায়ে কারোর কাছে কি উদাহরণ রয়েছে?

5
অক্সিজেন [বন্ধ] ব্যবহার করে কীভাবে পাইথন কোড নথিভুক্ত করবেন
বন্ধ । এই প্রশ্নটি আরও ফোকাস করা প্রয়োজন । এটি বর্তমানে উত্তর গ্রহণ করছে না। এই প্রশ্নটি উন্নত করতে চান? প্রশ্নটি আপডেট করুন যাতে এটি কেবলমাত্র এই পোস্টটি সম্পাদনা করে একটি সমস্যায় ফোকাস করে । 2 বছর আগে বন্ধ । এই প্রশ্নটি উন্নত করুন আমি সি বা পিএইচপি কোডের ডকুমেন্টেশন …

2
পুনর্গঠনপরিবন্ধে কীভাবে নেস্টেড তালিকা তৈরি করবেন?
আমি নিম্নলিখিত কোড ব্যবহার করে সঠিকভাবে নেস্টেড তালিকা তৈরি করার চেষ্টা করছি (নীচের স্পিনক্স এবং ডকুমেন্টাল ডক্স): 1. X a. U b. V c. W 2. Y 3. Z আমি আশা করি এটির ফলাফল দুটি হবে OLতবে পরিবর্তে আমি নিম্নলিখিত ফলাফলটি পেয়েছি: <ol class="arabic simple"> <li>X</li> </ol> <blockquote> <div> <ol …

6
রুট ডকুমেন্টের নীচে ডিরেক্টরিতে অবস্থিত নথির সাথে স্ফিংক্স লিঙ্ক করতে পারে?
আমি পাইথন নন প্রকল্পটি নথির জন্য স্ফিংস ব্যবহার করছি। আমি ./docপ্রতিটি সাবমডিউলে ফোল্ডারগুলি বিতরণ করতে চাই , submodule_name.rstসেই মডিউলটি নথিভুক্ত করার জন্য ফাইলগুলি। আমি তখন পুরো ডিজাইনের জন্য একটি নকশা তৈরি করতে সেই ফাইলগুলি মাস্টার হায়ারার্কিতে চুষতে চাই। অর্থাৎ: Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 …

3
পাইথন ডাস্ট্রিংয়ে ক্লাস পদ্ধতির লিঙ্ক
আমি একই ক্লাসের অন্য পদ্ধতির ডক্ট্রিংয়ের মধ্য থেকে আমার ক্লাসের একটি পদ্ধতির সাথে একটি লিঙ্ক যুক্ত করতে চাই। আমি স্পিংক্সে এবং পছন্দসই স্পাইদার এবং অন্যান্য পাইথন আইডিইতে লিঙ্কটি কাজ করতে চাই। আমি বেশ কয়েকটি অপশন চেষ্টা করেছিলাম এবং কেবলমাত্র একটি কাজ করে যা কার্যকর হয় তবে এটি জটিল। ধরুন নীচের …

1
দস্তাবেজগুলি বিল্ডটি ব্যর্থ হয় "" পিপ.ইনটার্নাল ইনডেক্স "থেকে 'প্যাকেজফাইন্ডার' নাম আমদানি করতে পারে না"
নীচের ত্রুটি (নীচে সম্পূর্ণ লগ) এর সাথে পঠন-দস্তাবেজে স্পিনক্স ডক্সের বিল্ড ব্যর্থ হয়েছে: ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) আমি কি কিছু ভুল করেছি বা ডকসগুলিতে এটি কোনও বাগ আছে? স্পিনক্স ডক্সের স্থানীয় বিল্ডটি ঠিকঠাক। দস্তাবেজগুলিতে সম্পূর্ণ ত্রুটি লগ করুন: Read the Docs build information Build id: 10299638 …

2
প্রশ্ন চিহ্নযুক্ত প্রথম ফাইল থেকে রূপান্তরিত এইচটিএমএল ফাইল ক্যাটালগটিতে ক্লিক করার জন্য ব্রাউজারে কেন প্রদর্শিত হবে না?
simple.7zআমি এখানে বর্ণিত বিষয়গুলি পুনরুত্পাদন করার জন্য দয়া করে ফাইলটি ডাউনলোড করুন এবং আপনার স্পিংক্সে ইনস্টল করুন, এটি পুনরুত্পাদন করতে আপনি চালাতে পারেন: make clean make html সমস্যাগুলি পুনরুত্পাদন করতে আপনার স্পিংক্সে ডাউনলোড এবং ইনস্টল করুন এখানে দুটি নিবন্ধ রয়েছে sample/source, সামগ্রী একই, কেবলমাত্র পার্থক্য শিরোনাম। cd sample ls source …
আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.