documentation-generation

10熱度

2回答

我想僅對所選模塊使用autodoc。我創建了一個文件，其中包括： .. automodule:: some.specific.module :members: 並且它會正確生成。不幸的是，autodoc一直試圖解析其他文件（並因導入錯誤而失敗）。我知道我可以嘲笑一些模塊，但我想要一個更好的解決方案 - 停止獅身人面像看他們開始。如何確保只裝載了所需的模塊，而不是（例如）test.o

8熱度

1回答

使用配音製作文檔

如何使用配音從我的源文件製作DDoc？在配音中似乎沒有默認命令來做到這一點，我真的希望能夠自動執行此過程。

1熱度

1回答

獅身人面像描述有效的輸入值到api

我一直在使用獅身人面像來記錄我們的api。正如人們所預料的那樣，在我們的api中有一些參數值是限制性的。例如，可能有一個用於描述電視的帖子的「開」參數，並且可能有相同的參數用於在GET上進行過濾。我的問題是，我找不到一個內置的方式來描述有效的參數值。對於布爾，我可以把它放在parens中，但有些參數有20個有效的輸入值，有些參數具有多個可能的輸入參數集，具體取決於路徑中多個變量點的值。例如： m

7熱度

1回答

爲什麼Doxygen對手機不那麼友好？

Doxygen似乎是C++（和許多其他語言）的代碼文檔的頭號選擇，但每次我從我的手機瀏覽Doxygen生成的文檔時，該網站litteraly不滾動，文本是可怕的小... 怎麼回事？我來自python/sphinx，像readthedocs.org這樣的網站在HTML代（IMO）中管理完美的移動友好性，而最流行的文檔系統卻不能？我肯定錯過了什麼。我試着環視interwebs一段HTML主題最小化

1熱度

1回答

參數VS在打字稿

選項基於這個問題Multiple arguments vs. options object 我想知道如何這確實適用於打字稿。我想作出如下決定：預編譯器/ lint給出的提示將盡可能相關。 generated documentation也將盡可能幹淨。的利弊我現在發現：打字稿可以處理可選參數相當不錯，但依靠參數的數量級，並具有參數一個長長的清單是不是我查找方便。使用option對象很不錯，但

0熱度

1回答

擴展jsDoc來處理自定義標籤

我期待擴展jsdoc（特別是docstrap）。我有一個nodeJS應用程序，並希望將jsdoc導航分割爲控制器，視圖等。我已經在一定程度上通過創建我的自定義標籤（如@controller），並設法讓它被類似於@module的JsDoc捕獲，因此它生成頁面（與描述）。然而，我的問題是，當涉及到與例如與'module.exports'功能位於控制器相關的功能。生成的文檔基本上忽略了@control

1熱度

1回答

從源代碼生成HTML報告

是否有一些工具（最好在Python中），允許您從任意源代碼（Python，R，Javascript等）生成HTML，Markdown或reStructuredText報告？到目前爲止，我發現的最接近的東西是pyreport，它只支持python。這個想法是能夠從文檔完整的源代碼中獲得快速報告。這與文學編程不同。在這裏我想類似如下的內容： file.py # ```*This is part of

-5熱度

1回答

像Doxygen這樣的工具可以生成在活動之間傳遞數據的文檔嗎？

我通過一個Android應用程序的活動之間數據的東西，如：在主要活動 Intent intent = new Intent(FirstActivity.this, SecondActivity.class); intent.putExtra("some_key", value); intent.putExtra("some_other_key", "a value"); startActiv

3熱度

1回答

可以使用pydoc來生成聯機幫助頁嗎？

我有一套python腳本，我想創建manpage。他們被記錄在docstrings中，所以我可以通過這種方式獲取文檔，但我也想要manpages。有沒有辦法使用pydoc爲man頁面生成* roff源代碼？編輯：類似於perl的pod2man for python。

2熱度

1回答

Paypal是否使用特定的工具來生成其REST API文檔

貝寶的REST API文檔（https://developer.paypal.com/docs/rest/api/）真的很不錯。這是使用工具生成的還是手動生成的？如果有使用的工具，它是什麼？