我目前正在使用Django管理文檔生成器記錄我所有的django視圖和模型。儘管我在所有文檔視圖中都沒有遇到任何問題,但是,在我的模型的文檔字符串中編寫的任何內容都在文檔中以明文形式呈現。Django管理文檔生成器不格式化文件的型號
換句話說,如果我想引用一個觀點:
:view:`appname.view_name`
將呈現爲一個鏈接(我想)如果插入到視圖中的文檔字符串,但將顯示爲「:當插入到任何模型的文檔字符串中時,以明文形式顯示「appname.view_name`」。但是,插入到模型的方法中時,格式將按預期工作。
起初我以爲這是文檔生成器的一個怪癖,也許它不會讀取模型文檔字符串的標記,但在閱讀文檔(在此處找到:https://docs.djangoproject.com/en/1.5/ref/contrib/admin/admindocs/#model-reference)之後,似乎您應該可以鏈接到文檔的其他部分。
我還沒有看到任何其他人有這個問題,我不知道從哪裏開始尋找解決方案。預先感謝您的任何專業知識和解釋。
編輯:
好像格式化主要模式的文檔字符串完全忽略 - 也就是說,它會忽略修改案文。
例如
類爲MyModel(models.Model):
「」 「
標題
」「」
將簡單地顯示爲標題django admin docs中的明文中的。
問題用附加信息更新。如果這在下一個補丁中出現,那將會很好。 – starr749
@ starr749雖然看起來並不太樂觀,但根據機票上的日期。我也很失望,有參數的模型方法沒有得到記錄 – zanderle
更新:這將得到補丁1.8 – zanderle