คำถามติดแท็ก python-sphinx

ฉันเกลียด RST แต่รักสฟิงซ์ มีวิธีที่สฟิงซ์อ่าน markdown แทนที่จะเป็น reStructuredText หรือไม่?

212 python  markdown  python-sphinx 

ฉันกำลังพยายามใช้สฟิงซ์เพื่อทำเอกสารโครงการแนว 5,000+ ใน Python มันมีประมาณ 7 โมดูลฐาน เท่าที่ฉันรู้เพื่อที่จะใช้ autodoc ฉันจำเป็นต้องเขียนโค้ดเช่นนี้สำหรับแต่ละไฟล์ในโครงการของฉัน: .. automodule:: mods.set.tests :members: :show-inheritance: นี่เป็นวิธีที่น่าเบื่อเกินไปเพราะฉันมีไฟล์มากมาย มันจะง่ายกว่านี้หากฉันสามารถระบุได้ว่าฉันต้องการให้เอกสาร 'mods' เป็นเอกสาร สฟิงซ์สามารถเรียกแพคเกจซ้ำแล้วซ้ำอีกและสร้างหน้าสำหรับแต่ละ submodule มีคุณสมบัติเช่นนี้หรือไม่? ถ้าไม่ใช่ฉันสามารถเขียนสคริปต์เพื่อสร้างไฟล์. rst ทั้งหมด แต่อาจใช้เวลานานมาก

149 python  python-sphinx  autodoc 

จะแทรกการอ้างอิงโยงในหน้า reST / Sphinx ไปยังส่วนหัวย่อยหรือจุดยึดในหน้าอื่นในชุดเอกสารเดียวกันได้อย่างไร

110 python-sphinx  restructuredtext 

ฉันกำลังพยายามเริ่มต้นกับ Sphinx และดูเหมือนจะมีปัญหาอย่างไม่หยุดยั้ง คำสั่ง: docs/sphinx-quickstart ฉันตอบคำถามทั้งหมดและทุกอย่างทำงานได้ดี คำสั่ง: docs/ls ทุกอย่างดูปกติ ผลลัพธ์:build Makefile source คำสั่ง: sphinx-build -d build/doctrees source build/html ดูเหมือนว่าจะได้ผล ฉันสามารถเปิดไฟล์ index.html และเห็น "เปลือก" ของสิ่งที่ฉันต้องการ เมื่อฉันลองใส่ซอร์สโค้ดจริงของฉันเป็นsourceโฟลเดอร์ที่ฉันพบปัญหา คำสั่ง: sphinx-build -d build/doctrees ../ys_utils build/html ผลลัพธ์: Making output directory... Running Sphinx v1.1.3 loading pickled environment... not yet created No builder selected, using default: html …

108 python  python-sphinx  autodoc 

Sphinx ไม่สร้างเอกสารสำหรับ __init __ (self) ตามค่าเริ่มต้น ฉันได้ลองทำสิ่งต่อไปนี้แล้ว: .. automodule:: mymodule :members: และ ..autoclass:: MyClass :members: ใน conf.py การตั้งค่าต่อไปนี้จะต่อท้ายเฉพาะ __init __ (self) docstring เข้ากับ class docstring ( เอกสาร Autodoc ของ Sphinxดูเหมือนจะยอมรับว่านี่เป็นพฤติกรรมที่คาดหวัง แต่ไม่ได้ระบุอะไรเกี่ยวกับปัญหาที่ฉันกำลังพยายามแก้ไข): autoclass_content = 'both'

107 python  python-sphinx  autodoc 

ฉันใช้สฟิงซ์และปลั๊กอิน autodoc เพื่อสร้างเอกสาร API สำหรับโมดูล Python ของฉัน ในขณะที่ฉันสามารถดูวิธีจัดทำเอกสารพารามิเตอร์เฉพาะได้อย่างสวยงาม แต่ฉันไม่พบตัวอย่างวิธีการจัดทำเอกสาร**kwargsพารามิเตอร์ ใครมีตัวอย่างวิธีที่ชัดเจนในการจัดทำเอกสารเหล่านี้บ้าง?

102 python  python-sphinx  autodoc 

ปิด . คำถามนี้จะต้องมีมากขึ้นมุ่งเน้น ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เน้นไปที่ปัญหาเดียวโดยแก้ไขโพสต์นี้เท่านั้น ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ ฉันชอบ Doxygen ในการสร้างเอกสารของรหัส C หรือ PHP ฉันมีโครงการ Python ที่กำลังจะมาถึงและฉันคิดว่าฉันจำได้ว่า Python ไม่มี/* .. */ความคิดเห็นและยังมีสิ่งอำนวยความสะดวกในการจัดทำเอกสารด้วยตนเองซึ่งดูเหมือนจะเป็นวิธีการจัดทำเอกสารแบบไพ ธ อน เนื่องจากฉันคุ้นเคยกับ Doxygen ฉันจะใช้มันเพื่อสร้างเอกสาร Python ได้อย่างไร มีอะไรเป็นพิเศษที่ฉันต้องระวังหรือไม่?

94 python  documentation  python-sphinx  doxygen  docstring 

ฉันกำลังพยายามสร้างรายการที่ซ้อนกันอย่างถูกต้องโดยใช้รหัสต่อไปนี้ (ตามเอกสารSphinxและdocutils ): 1. X a. U b. V c. W 2. Y 3. Z ฉันคาดว่าสิ่งนี้จะได้ผลลัพธ์เป็นสองOLวินาที แต่ฉันได้ผลลัพธ์ต่อไปนี้แทน: <ol class="arabic simple"> <li>X</li> </ol> <blockquote> <div> <ol class="loweralpha simple"> <li>U</li> <li>V</li> <li>W</li> </ol> </div> </blockquote> <ol class="arabic simple" start="2"> <li>Y</li> <li>Z</li> </ol> ผมทำอะไรผิดหรือเปล่า? เป็นไปไม่ได้ที่จะได้รับผลลัพธ์ต่อไปนี้หรือไม่? <ol class="arabic simple"> <li>X <ol class="loweralpha simple"> <li>U</li> …

91 markup  restructuredtext  python-sphinx 

ฉันใช้ Sphinx เพื่อจัดทำเอกสารโครงการที่ไม่ใช่ Python ฉันต้องการกระจาย./docโฟลเดอร์ในแต่ละโมดูลย่อยที่มีsubmodule_name.rstไฟล์เพื่อจัดทำเอกสารโมดูลนั้น จากนั้นฉันต้องการดูดไฟล์เหล่านั้นลงในลำดับชั้นหลักเพื่อสร้างข้อมูลจำเพาะสำหรับการออกแบบทั้งหมด ได้แก่ : Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst src ฉันพยายามรวมไฟล์ในโททรีproject_spec.rstเอกสารหลักดังนี้: .. toctree:: :numbered: :maxdepth: 2 Module 1 <../../modules/module1/docs/module1> อย่างไรก็ตามผลลัพธ์ของข้อความแสดงข้อผิดพลาดนี้: คำเตือน: toctree มีการอ้างอิงถึงเอกสารที่ไม่มีอยู่ u'modules / module1 / docs / module1 ' ไม่สามารถใช้../ในเส้นทางเอกสารได้หรือไม่? อัปเดต: เพิ่มตำแหน่ง conf.py อัปเดต: นอกเหนือจากเคล็ดลับรวมด้านล่างนี้ยังเป็นไปไม่ได้ (2019) …

91 python  python-sphinx  symlink  toctree 

ฉันต้องการเพิ่มลิงก์ไปยังเมธอดในคลาสของฉันจากภายใน docstring ของเมธอดอื่นของคลาสเดียวกัน ฉันต้องการให้ลิงก์ทำงานในสฟิงซ์และควรอยู่ใน Spyder และ Python IDE อื่น ๆ ด้วย ฉันลองใช้หลายตัวเลือกและพบว่ามีเพียงตัวเดียวที่ใช้งานได้ แต่ก็ยุ่งยาก สมมติว่าโครงสร้างต่อไปนี้ใน mymodule.py def class MyClass(): def foo(self): print 'foo' def bar(self): """This method does the same as <link to foo>""" print 'foo' ฉันลองใช้ตัวเลือกต่อไปนี้สำหรับ<link to foo>: : func: `foo` : func: `self.foo` : func: `MyClass.foo` : func: `mymodule.MyClass.foo` …

90 python  python-sphinx  spyder 

การสร้างเอกสาร Sphinx ใน read-the-docs ล้มเหลวด้วยข้อผิดพลาดต่อไปนี้ (บันทึกที่สมบูรณ์ด้านล่าง): 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 Project: cascade-python Version: latest Commit: a7d50bf781bd8076b10dd7024db4ccb628016c27 Date: 2020-01-21T17:03:12.876711Z State: finished Success: False [rtd-command-info] start-time: 2020-01-21T17:03:13.203354Z, end-time: 2020-01-21T17:03:13.215400Z, duration: 0, exit-code: 0 git remote set-url origin …

25 python  python-sphinx  read-the-docs 

โปรดดาวน์โหลดไฟล์simple.7zและติดตั้งในสฟิงซ์ของคุณเพื่อทำซ้ำปัญหาที่ฉันอธิบายไว้ที่นี่เพื่อทำซ้ำคุณสามารถเรียกใช้: make clean make html ดาวน์โหลดและติดตั้งในสฟิงซ์ของคุณเพื่อทำให้เกิดปัญหาอีกครั้ง มีสองบทความในsample/sourceเนื้อหาเหมือนกันความแตกต่างเพียงอย่างเดียวคือชื่อ cd sample ls source |grep "for-loop" What does "_" in Python mean in a for-loop.rst What does "_" in Python mean in a for-loop?.rst หนึ่งที่มีอยู่ในนั้นอีกไม่ได้มี? ?happend make htmlสิ่งที่แปลกหลังจากการทำงาน make html ls build/html|grep "for-loop" What does "_" in Python mean in a for-loop.html What …

14 python  python-sphinx