bitshift
1.0.0
bitshift เป็นเครื่องมือค้นหาความหมายสำหรับซอร์สโค้ดที่พัฒนาโดย Benjamin Attal, Ben Kurtovic และ Severyn Kozak README นี้มีไว้สำหรับนักพัฒนาเท่านั้น สำหรับภาพรวมผู้ใช้ของโครงการ:
master
: โค้ดที่ใช้งานได้, ทดสอบแล้ว, หมายเลขเวอร์ชัน - ไม่มีการคอมมิตโดยตรง; ควรยอมรับการผสานจาก develop
เมื่อพร้อมที่จะเผยแพร่เท่านั้นdevelop
: สาขาการรวมเข้ากับโค้ดที่ยังไม่เผยแพร่ แต่ใช้งานได้เป็นส่วนใหญ่ - อนุญาตการคอมมิตโดยตรง แต่ควรเป็นโค้ดรองfeature/*
: ส่วนประกอบแต่ละส่วนของโครงการที่มีโค้ดที่ยังไม่ผ่านการทดสอบและน่าจะใช้งานไม่ได้อย่างน่ากลัว - แยกสาขาออกและรวมเข้ากับ develop
เมื่อเสร็จสิ้น bitshift ใช้ SASS เพื่อจัดแต่งทรงผม รวบรวมสไตล์ชีตเป็น CSS ด้วย sass --watch static/sass/:static/css
หากต้องการสร้างเอกสาร ให้รัน make html
จากไดเร็กทอรีย่อย docs
จากนั้นคุณสามารถเรียกดูได้จาก docs/build/html/index.html
หากต้องการอัปเดตโครงสร้างเอกสาร API โดยอัตโนมัติ (จำเป็นเมื่อเพิ่มโมดูลหรือแพ็คเกจใหม่ แต่ ไม่ใช่ เมื่อเพิ่มฟังก์ชันหรือเปลี่ยนสตริงเอกสาร) ให้รัน sphinx-apidoc -fo docs/source/api bitshift
จากรูทโปรเจ็กต์ โปรดทราบว่าการดำเนินการนี้จะคืนค่าการเปลี่ยนแปลงที่กำหนดเองที่ทำกับไฟล์ใน docs/source/api
ดังนั้นคุณอาจต้องการอัปเดตด้วยตนเองแทน
__version__
ใน bitshift/__init__.py
, version
ใน setup.py
และ version
และ release
ใน docs/conf.py