2
我正在開發一個docstring查看器,所以我想正確地將任何文檔字符串轉換爲好看的html。如何可靠地檢測python文檔串是否處於休眠狀態?
大多數標準庫中的文檔不在reST中,但對於大多數情況下采用了numpydoc標準的科學庫,情況並非如此。
所以我想可靠地檢測一個文檔字符串是否在reST中,以便將它傳遞給不同的呈現器。
我正在開發一個docstring查看器,所以我想正確地將任何文檔字符串轉換爲好看的html。如何可靠地檢測python文檔串是否處於休眠狀態?
大多數標準庫中的文檔不在reST中,但對於大多數情況下采用了numpydoc標準的科學庫,情況並非如此。
所以我想可靠地檢測一個文檔字符串是否在reST中,以便將它傳遞給不同的呈現器。
由於ReST是一種嘗試儘可能尋找可讀的純文本格式,因此沒有可靠的方法來檢測是否有任何文本正在使用ReST,更不用說像文檔字符串一樣小的東西了。
我想說你應該試試把它渲染爲ReST,並讓最終用戶選擇再次關閉它。
也許他可以嘗試一下。測試是否沒有嚴重違規,然後假設它至少符合要求。 (例如:沒有html標籤或@param結構...) –
不是那種我期待的答案:)但你是對的。我會嘗試將標準庫中的docstrings呈現爲未格式化的html,以及來自科學圖書館的Sphinx。但我也會給用戶一個簡單的選擇,從一個切換到另一個。 –