MkAutoDocs

GPT-3.5代碼文檔存儲庫

該存儲庫展示了使用OpenAI的GPT-3.5語言模型自動生成文檔的使用。然後，生成的文檔將變成一個“ DOC作為代碼”站點，以方便訪問和共享。

入門

要使用此存儲庫，您需要具有以下內容：

• GPT-3.5語言模型的有效OpenAI API密鑰。
• 您要生成文檔的代碼庫。

用法

1. 克隆或將此存儲庫下載到您的本地計算機。
2. 通過在root Directory中創建.env文件並添加以下行來設置OpenAI API鍵，您可以重命名示例.env：env：

 OPENAI_API_KEY=<your-api-key>

1. 安裝所需的依賴項Python，然後安裝後使用以下命令：

 cd ./MKAutoDocs/
pip install -r requirements.txt

4. 編輯配置文件以指向您的代碼存儲庫。
   1. Docs_path：所需DOC文件夾的相對路徑（應與配置文件中的MKDOC匹配）。
   2. root_dir：絕對路徑或所需項目根目錄的相對路徑。
   3. source_to_document：
      • 絕對路徑或您想要在根目錄中解析和記錄的文件夾的相對路徑。
   4. 要求：將您的文檔作為代碼站點運行的Python依賴列表。
      • MKDOC：1.4.2
      • pymdown-extensions：9.11
   5. ignore_folders：要忽略的文件夾/子文件夾的正則列表。如果願意，請刪除任何或全部。
      • 。 +。 git
      • .pytest
      • 包括
      • lib
      • 腳本
   6. ignore_files：要忽略的文件正則列表。如果願意，請刪除任何或全部。
      • 。 *
      • ^（？！ 。。$）。
   7. USE_STATE：一個布爾值，這將使文件在每次運行中都無法再生。如果您想更新文檔，請隨時關閉。
5. 運行以下命令為您的代碼生成文檔：

 python Auto_Doc.py

這將使用GPT-3.5語言模型為您的代碼庫生成文檔，並將生成的文檔作為已配置docs目錄中的Markdown文件輸出。

1. 運行靜態站點生成器MKDOCS將生成的文檔轉換為“ DOC作為代碼”站點。

例如，要使用MKDOCS，請在根目錄中運行以下命令以預覽網站：

 mkdocs serve

或使用MKDOC來構建一個網站：

 mkdocs build

這將在site目錄中生成一個靜態網站，您可以在服務器上託管或諸如GitHub頁面之類的服務。

如果您想在github頁面上託管。您可以設置GitHub操作，以自動刪除您的文檔，作為代碼站點MKDOC如何手動使用以下方式：

 mkdocs gh-deploy

貢獻

如果您想為此存儲庫做出貢獻，請隨時打開拉動請求或問題。我們歡迎對代碼的任何反饋，建議或改進。

執照

該存儲庫是根據MIT許可證獲得許可的。有關更多信息，請參見LICENSE文件。