สฟิงซ์ฉันเป็นเครื่องมือที่มีงูใหญ่ที่จะสร้างเปลือกเอกสารสฟิงซ์สำหรับโครงการของคุณและรวมถึงไฟล์ README เป็นดัชนีเอกสาร & nbsp;. สามารถจัดการกับการสกัดข้อมูล meta ที่จำเป็นเช่นชื่อโครงการนักเขียนและรุ่นจากคุณ โครงการสำหรับใช้ในสฟิงซ์เอกสารของคุณ
เมื่อคุณใช้สฟิงซ์ให้เราสร้างเอกสารสฟิงซ์ของคุณแล้วคุณสามารถเพิ่มโครงการของคุณที่จะอ่านเอกสารและเว็บไซต์มี README โครงการของคุณเป็นเจ้าภาพกับชุดรูปแบบเอกสารสฟิงซ์ที่น่าสนใจ
หมายเหตุ: ไฟล์ README ของคุณควรจะอยู่ในรูปแบบที่รองรับ reStructuredText
การติดตั้ง
วิธีที่ง่ายที่สุดในการติดตั้งสฟิงซ์เป็นฉันโดยตรงจาก PyPI ใช้ pip หรือ setuptools โดยใช้คำสั่งที่เกี่ยวข้องดังต่อไปนี้:
PIP ติดตั้ง -U สฟิงซ์ฉัน
หรือ:
easy_install -U สฟิงซ์ฉัน
มิฉะนั้นคุณสามารถดาวน์โหลดสฟิงซ์ฉันและติดตั้งโดยตรงจากแหล่งที่มา:
หลาม setup.py ติดตั้ง
ทำงาน
สฟิงซ์ฉันจะได้รับการติดตั้งเป็นสคริปต์ทั้งระบบที่สามารถทำงานจากบรรทัดคำสั่งในขณะที่ในไดเรกทอรีรากโครงการของคุณ:
สฟิงซ์ฉัน
เมื่อทำงานในไดเรกทอรีโครงการของคุณก็จะสร้างไดเรกทอรีเอกสารที่มีสองไฟล์โมดูล conf.py สฟิงซ์และไฟล์ index.rst ซึ่งจะรวมถึง README โครงการของคุณ
โมดูล conf.py เรียกฟังก์ชั่นการติดตั้งจากสฟิงซ์ผมว่าตั้งค่าการตั้งค่าที่จำเป็นขั้นต่ำสำหรับสฟิงซ์เอกสารของคุณ
- โครงการ - ชื่อไดเรกทอรีของโครงการของคุณจะใช้
- รุ่น - ที่ดึงมาจากหาเรื่องรุ่นของสคริปต์ setup.py ของคุณหรือแอตทริบิวต์ __version__ แพคเกจของคุณ
- ลิขสิทธิ์ - ดึงมาจากผู้เขียนหาเรื่องของสคริปต์ของคุณ setup.py หรือแอตทริบิวต์ __author__ แพคเกจของคุณ
ต้องการ
- . งูหลาม
ความคิดเห็นที่ไม่พบ