كيف يمكن الحصول على وثائق بايثون في Texinfo معلومات تنسيق ؟

StackOverflow https://stackoverflow.com/questions/1054903

سؤال

منذ بيثون 2.6 ، يبدو أن الوثائق الجديدة ، reStructuredText تنسيق و لا يبدو من السهل جدا لبناء Texinfo معلومات ملف من خارج منطقة الجزاء بعد الآن.

أنا Emacs المدمن و تفضل الوثائق المثبتة في المعلومات.

هل من أحد لديه بيثون 2.6 أو أحدث المستندات في Texinfo تنسيق ؟ كيف يمكنك تحويل لهم ؟ أو هل هناك حافظت بناء في مكان ما هناك ؟

وأنا أعلم أنني يمكن استخدام w3m أو haddoc لعرض مستندات html - أريد حقا لهم في المعلومات.

لقد لعبت مع Pandoc ولكن بعد بضع تجارب صغيرة يبدو أنها لا تتعامل بشكل جيد مع الروابط بين الوثائق و أكبر التجربة - تشغيل جميع مستندات القط رائد معا لنرى ماذا سيحدث - لا يزال الأزيز على طول يومين منذ أن بدأت ذلك!

اثنين إجابات جيدة

تسليط الضوء على اثنين من الإجابات أدناه ، لأن ذلك لن يسمح لي أن أقبل كل الإجابات:

  • @ويلفريد هيوز: تثبيت من MELPA هو أسرع طريقة للحصول على ما قبل بناء المعلومات في Emacs
  • @alioth: بناء عليه بنفسك يبدو أنه أسهل كثيرا عندما سألت هذا السؤال في عام 2009
هل كانت مفيدة؟

المحلول

لقد تعبئتها حتى بيثون مستندات الملف texinfo.

إذا كنت تستخدم Emacs مع MELPA ، يمكنك ببساطة تثبيت هذا مع M-x package-install python-info.

نصائح أخرى

جون Waltman http://bitbucket.org/jonwaltman/sphinx-info وقد متشعب أبو الهول و كتب texinfo البناء ، فإنه يمكن بناء الثعبان الوثائق (لم يتم ذلك).يبدو أنه سيتم دمج قريبا في أبو الهول.

هنا روابط سريعة للتحميل (مؤقت):

خطوات لتوليد الثعبان دكتور في texinfo الشكل:

تحميل الثعبان رمز المصدر

تحميل وتثبيت أبو الهول-معلومات حزمة (في virtualenv)

أدخل في بيثون/Doc دليل من مصادر الثعبان

تحرير Makefile ، build الهدف محل $(PYTHON) tools/sphinx-build.py مع sphinx-build, ثم إضافة هذا الهدف إلى makefile, الانتباه, الفضاء قبل صدى تبويب:

texinfo: BUILDER = texinfo
texinfo: build
    @echo
    @echo "Build finished. The Texinfo files are in _build/texinfo."
    @echo "Run \`make' in that directory to run these through makeinfo" \
          "(use \`make info' here to do that automatically)."

تحرير Python/Doc/conf.py مضيفا:

texinfo_documents = [
    ('contents', 'python', 'Python Documentation', 'Georg Brandl',
     'Python', 'The Python Programming Language', 'Documentation tools',
     1),
]

ثم تشغيل make texinfo وينبغي أن تنتج texifile في بناء/texinfo الدليل.لتوليد معلومات ملف تشغيل makeinfo python.texi

لا شك أنه سيكون باردة وصعبة لتوليد الثعبان وثائق خاصة بك الثعبان النسخة من قبل نفسك.فقط اتبع EmacsWiki, أو لا تتردد في تجميع محليا (في دبيان جيسي على Python3.4.2):

sudo apt-get install python3-sphinx
cd ~/Desktop
wget https://www.python.org/ftp/python/3.4.2/Python-3.4.2rc1.tar.xz
tar -xf Python-3.4.2rc1.tar.xz
cd Python-3.4.2rc1/Doc/
sphinx-build -b texinfo -d build/doctrees . build/texinfo
# extra time to build
cd build/texinfo/
makeinfo python.texi
# extra time for convertation

حصلت هذه الشجرة:

.                                                                                                                              
├── logging_flow.png                                                                                                           
├── Makefile                                                                                                                   
├── pathlib-inheritance.png                                                                                                    
├── python.info                                                                                                                
├── python.info-1                                                                                                              
├── python.info-10                                                                                                             
├── python.info-11                                                                                                             
├── python.info-12                                                                                                             
├── python.info-13                                                                                                             
├── python.info-14                                                                                                             
├── python.info-15                                                                                                             
├── python.info-16                                                                                                             
├── python.info-17                                                                                                             
├── python.info-18                                                                                                             
├── python.info-19                                                                                                             
├── python.info-2                                                                                                              
├── python.info-20                                                                                                             
├── python.info-21                                                                                                             
├── python.info-22                                                                                                             
├── python.info-23                                                                                                             
├── python.info-24                                                                                                             
├── python.info-25                                                                                                             
├── python.info-26                                                                                                             
├── python.info-27                                                                                                             
├── python.info-28                                                                                                             
├── python.info-29                                                                                                             
├── python.info-3                                                                                                              
├── python.info-30                                                                                                             
├── python.info-31                                                                                                             
├── python.info-32                                                                                                             
├── python.info-33                                                                                                             
├── python.info-34                                                                                                             
├── python.info-4                                                                                                              
├── python.info-5                                                                                                              
├── python.info-6                                                                                                              
├── python.info-7                                                                                                              
├── python.info-8                                                                                                              
├── python.info-9                                                                                                              
├── python.texi                                                                                                                
├── python-video-icon.png                                                                                                      
├── tulip_coro.png                                                                                                             
└── turtle-star.png

و الآن من الممكن استعراض وثائق بايثون أصلا في Emacs قبل

ج-u C h i الثعبان-معلومات RET

بيثون-معلومات اسم الملف (الرابع في الشجرة أعلاه) ، حتى أن المرجعية في بعض التعسفي العقد عن المعتاد و مراجعة منتظمة من الراحة.

بالنسبة لأولئك الذين يتبعون هذا السؤال أملا في إجابة ، وجدت آخر rst2texinfo التنفيذ التي قد ترغب في محاولة:

http://bitbucket.org/jonwaltman/rst2texinfo/src

آخر "الحل" هو تنفيذ pydoc كما اقترح Nikokrock مباشرة في Emacs:

(defun pydoc (&optional arg)
  (interactive)
  (when (not (stringp arg))
    (setq arg (thing-at-point 'word)))

  (setq cmd (concat "pydoc " arg))
  (ad-activate-regexp "auto-compile-yes-or-no-p-always-yes")
  (shell-command cmd)
  (setq pydoc-buf (get-buffer "*Shell Command Output*"))
  (switch-to-buffer-other-window pydoc-buf)
  (python-mode)
  (ad-deactivate-regexp "auto-compile-yes-or-no-p-always-yes")
)

مايكل إرنست تستخدم للحفاظ على معلومات صيغ الثعبان مستندات:

http://www.cs.washington.edu/homes/mernst/software/#python-info

يمكنك محاولة استخدام makefile و html2texi سكربت توليد نسخة محدثة.وكلاهما مرتبط في العنوان أعلاه.لست متأكدا كيف أنها تعمل بشكل جيد الآن (النسخة الأخيرة حول 2001) ، ولكن السيناريو له وعلق (grep عن "الثعبان").

بيثون مستندات يتم الآن إنشاء باستخدام سفين الإطار.هذا الإطار لا يكون texinfo تنسيق الإخراج.يضم حاليا:

  1. HTML
  2. اللاتكس
  3. نص عادي

ربما يمكنك الحصول على ما تريد باستخدام المطاط الناتج.مع إخراج النص سوف فقدت الصليب المرجع.

Personnaly أنا أفضل استخدام pydoc عندما أريد النصي الإخراج.مع همة لدي shorcut الاتصال pydoc و فتح نافذة مع الطبيب من أجل الكيان تحت المؤشر...

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top