當前位置:編程學習大全網 - 編程軟體 - 如何才能寫出簡潔好看的API文檔,有沒有開源框架可以用

如何才能寫出簡潔好看的API文檔,有沒有開源框架可以用

妳需要Sphinx!!!

Python的官方文檔就是用這個寫的。不過註意這個Sphinx是壹個文檔編寫工具而不是那個有名的全文檢索引擎。

Sphinx使用reStructuredText 標記語法(和其他壹些語法)來提供文檔控制。reStructuredText 和Markdown類似,但是功能更為強大。

更為方便的是,網上有壹個網站提供rst的在線編輯器,地址為http://rst.ninjs.org/,妳可以像使用編輯器壹樣來編寫妳的API文檔,然後復制到Sphinx項目中去就行了。

最後make html壹下就生成了靜態網頁的文檔,還能選擇或者自定義模板。

  • 上一篇:bmi編程
  • 下一篇:photoshop 數字圖像處理中陣列和矩陣有什麽區別
  • copyright 2024編程學習大全網