ฉันจะเพิ่มลิงก์ไปยังหน้าอื่นใน reStructuredText ได้อย่างไร [ทำซ้ำ]

ฉันใช้ Sphinx เพื่อสร้างเอกสารสำหรับโครงการของฉัน แต่ฉันกำลังดิ้นรนเพื่อทำความเข้าใจแนวคิดพื้นฐานเกี่ยวกับ RST

ฉันมีโปรเจ็กต์พื้นฐานที่มี index.rst และฉันใช้ sphinx-rtd-theme เพื่อจัดสไตล์ ดังนั้นฉันจึงสร้าง html และทางด้านซ้ายฉันมีเมนู เช่นเดียวกับ ที่นี่. ตอนนี้ฉันสร้างหน้าใหม่สำหรับเอกสารประกอบ และไฟล์แรกชื่อ auth.rst

สิ่งที่ฉันไม่เข้าใจคือ ฉันจะเพิ่มลิงก์ไปยังหน้าอื่นๆ เช่น auth.rst ในเมนูด้านข้างทางด้านซ้ายได้อย่างไร ตอนนี้ ฉันมีลิงก์สองลิงก์ในเมนูนั้น: ยินดีต้อนรับสู่เอกสารของ Test-API! และ ดัชนีและตาราง ฉันจะเพิ่มลิงก์ใหม่ไปยังหน้าอื่นๆ ของเอกสารของฉันได้อย่างไร ฉันไม่เข้าใจว่าสิ่งนี้กำหนดไว้ที่ไหนในโค้ดด้านล่าง และฉันไม่พบอะไรเกี่ยวกับเรื่องนี้มากนัก

Welcome to Test-API's documentation!
================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

python python-sphinx restructuredtext
person JayK23    schedule 09.02.2021    source แหล่งที่มา

คำตอบ (1)


arrow_upward
1
arrow_downward

ใต้ ':caption ...' คุณเขียนเส้นทางสัมพันธ์ (จากที่ไฟล์ RST นี้อยู่บนดิสก์) ไปยังเป้าหมาย rst (auth.rst ในกรณีของคุณ)

ตัวอย่างตามโครงสร้างโฟลเดอร์นี้:

RST
  |- a.rst
  |- b.rst
  |-folder2 
    |-c.rst
    |-d.rst

ใน a ถ้าฉันต้องการอ้างอิงถึง b และ c ฉันอาจมี:

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   b
   folder2/c

และถ้าฉันต้องการอ้างอิง d จาก c ฉันจะทำสิ่งนี้ใน c:

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   d
person CowKeyMan    schedule 09.02.2021