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文件。