6
對於Python的Sphinx如何避免將所有方法/函數名稱按字母順序排列在HTML中? 我想保持它們在源代碼中找到的順序。Python - 如何不按字母順序對獅身人面像輸出進行排序
對於Python的Sphinx如何避免將所有方法/函數名稱按字母順序排列在HTML中? 我想保持它們在源代碼中找到的順序。Python - 如何不按字母順序對獅身人面像輸出進行排序
從sphinx.ext.autodoc documentation:
autodoc_member_order
此值選擇是否自動記錄部件進行排序字母(值「字母」),由成員類型(值「成組」)或由源順序(值'bysource')。默認是按字母順序排列的。
請注意,對於源訂單,模塊必須是可用的源代碼的Python模塊。
所以在你conf.py文件的地方,放:
autodoc_member_order = 'bysource'
謝謝@詹姆斯。我錯過了。 –
如果Sphinx無法找到您的源代碼,請確保您通過'sys.path.insert(0,os.path.abspath('path/to/source')''包含在'conf.py'中的路徑。在我的情況下,這個路徑是錯誤的,但Sphinx沒有給出錯誤,因爲該模塊也是本地安裝的,並且可以毫無問題地導入,儘管Sphinx找不到源代碼。 – eatcrayons