documentation

1熱度

2回答

獅身人面像通常會增量生成文檔，這意味着只有已更改的文件纔會重新生成。我想知道是否有辦法告訴獅身人面像總是重新生成某些文件，這些文件可能並未直接更改，但會受到其他文件更改的影響。更具體一點：有沒有辦法告訴Sphinx總是重新生成包含某個指令的文件？我正在處理的文檔依賴於通過指令相當頻繁地從其他頁面收集和重新格式化信息的可能性。乾淨（make clean && make [html]）和/或完整（sp

0熱度

1回答

JIRA：創建API文檔

是否可以在JIRA上創建API文檔？如果是，那麼如何？目前採用的方法涉及創建/更新Microsoft Word文檔並將其替換爲Confluence。這種方法雖然符合要求，但似乎並不是API文檔管理的更好方式。謝謝

0熱度

2回答

如何抑制stylecop錯誤SA1650（錯誤拼寫的單詞）

我有一個類的文檔標題，根據stylecop沒有正確拼寫的單詞。不過，它們是代碼特定的，需要在那裏。錯誤SA1650：CSharp.Documentation：內摘要標籤包含拼寫錯誤的單詞的文檔文本：... 我想取消錯誤。我怎樣才能做到這一點？

1熱度

2回答

JSDoc - 如何使用通用鍵名稱記錄對象？

我需要使用JSDoc來記錄一個ES6類，它接受一個具有鍵名稱作爲人名的屬性的對象，因此鍵名稱幾乎可以是任何字符串，而不是預定義的。所以對象的結構應該是這樣的： { "Name of person": { "age": 31, "hobby": "Tennis" }, "Name of another person": { "age"

0熱度

1回答

鎖定文檔的文本

我正在尋找一種方法來鎖定一個文檔的內容。例如：我從Oracle購買了一個文檔，它上面有我的名字作爲水印，不能應用複製粘貼。我想在文檔上應用某種安全性，以便它不能被複制。我看到了DRM在互聯網上經過一番研究，但沒有任何簡單，免費的方式？提前謝謝！

0熱度

1回答

nifi如何生成文檔？

翻閱Apache nifi的源代碼，我發現他們在代碼的開頭使用@符號生成他們的文檔。 Here's an example for reference.如何從這些行生成文檔？這可能使用scala嗎？

0熱度

1回答

Docstring中未解決的引用警告 - Python 3.6 - Pycharm 17.1.4

我收到來自PyCharm的有關未解決的引用的警告。這是代碼結構相似，並且也應該收到警告。 class Parent: """ === Attributes === @type public_attribute_1: str """ def __init__(self): public_attribute_1 = '' pa

3熱度

1回答

結合幾個項目的獅身人面像文件

在我們的團隊中，我們有幾個項目，每個項目都分別記錄了獅身人面像。我們希望有一箇中央文檔頁面，其中包括我們所有的項目。當然，我們可以建立一個鏈接到不同文檔的html頁面。有沒有辦法將文檔與Sphinx本身結合？也許有一個單獨的文檔項目，其中包含其他項目的文檔？

1熱度

2回答

抓取解析器後sphinxcontrib-autoprogram解析參數？

我正在創建一個使用子命令模式的命令行界面的Python包：kevlar count，kevlar partition等等。 CLI的工作原理非常奇妙，現在我試圖將CLI添加到我的Sphinx文檔中。在尋找解決方案時，我碰到了sphinxcontrib-autoprogram，這似乎正是我想要的，甚至明確地處理子命令。但是當我執行獅身人面像構建時，出現以下錯誤。 sphinx-build -b ht

1熱度

1回答

獅身人面像文檔：定義但隱藏標題/標題文本

我正在使用Sphinx來記錄Python包。標題頁面/啓動頁面的頂部顯示了一個帶有項目標識和文本的圖形。這給出了我想要的視覺外觀，但由於我沒有定義頂級標題，所以頁面title元數據（在瀏覽器選項卡中呈現）設置爲<no title> — my project name。有沒有辦法可以做到以下一種？定義一個標題文本，但沒有渲染爲頁面上的標題？以其他方式設置title頁面元數據？