這兩天用sphinx聯繫寫文檔感覺還是很舒服的,就是感覺技巧有點多,版本還不太穩定,比如用default的主題可以定製側邊欄是固定的,但使用sphinxdoc主題就沒有這個功能有點鬱悶。還有就是中文包翻譯的不太全需要自己手動修改,中文檢索需要上網看別人的實現。在右上角現實modindex就費了我很多天時間,結果官方文檔寫着是通過rellinks這個全局變量來定義的,只怪自己英語不好看了很多遍都沒注意還是諮詢別人才瞭解的。因爲modindex這東西只有在你的文檔裏出現了 .. module:: 的時候纔會在右上角顯示的所以我怎麼弄也出不來。仔細查了源碼只要把sphinx/builders/html.py中224行後半句 and self.env.modules:註釋掉就可以了。唉,真是不該跟這東西鑽牛角尖。
使用sphinx寫文檔
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章
使用pydiction導出django字典
fuadam
2020-06-29 15:18:58
用vim寫sphinx
fuadam
2020-06-29 15:18:57
在cygwin環境下編譯node.js
fuadam
2020-02-20 18:33:13
終於理解了unicode、utf-8、gb2312這些編碼集之間的關係了
fuadam
2020-02-20 18:33:13
寫了一個生成reStructuredText表格的vim插件
fuadam
2020-02-20 18:33:01
解決pydiction在(後無法補全的問題
fuadam
2020-02-20 18:33:01
使用pydiction導出django字典
fuadam
2020-06-29 15:18:58
用vim寫sphinx
fuadam
2020-06-29 15:18:57
在cygwin環境下編譯node.js
fuadam
2020-02-20 18:33:13
終於理解了unicode、utf-8、gb2312這些編碼集之間的關係了
fuadam
2020-02-20 18:33:13
寫了一個生成reStructuredText表格的vim插件
fuadam
2020-02-20 18:33:01
解決pydiction在(後無法補全的問題
fuadam
2020-02-20 18:33:01
面試題——找出1000個連續數中出現的一個重複數
fuadam
2018-08-23 11:05:16
在mac osx中vim可以使用系統剪貼板了
fuadam
2018-08-23 11:05:15
mac終端下vim配色備份
fuadam
2018-08-23 11:05:15