MkAutoDocs

GPT-3.5コードドキュメントリポジトリ

このリポジトリは、コードのドキュメントを自動的に生成するためのOpenaiのGPT-3.5言語モデルの使用を紹介します。生成されたドキュメントは、簡単にアクセスして共有できる「コードとしてのDoc」サイトに変換されます。

はじめる

このリポジトリを使用するには、次のものを使用する必要があります。

• GPT-3.5言語モデルの有効なOpenAI APIキー。
• ドキュメントを生成するコードベース。

使用法

1. このリポジトリをローカルマシンにクローンまたはダウンロードしてください。
2. ルートディレクトリに.envファイルを作成し、次の行を追加してOpenAI APIキーを設定して、Example.Envの名前を変更できます。

 OPENAI_API_KEY=<your-api-key>

1. 必要な依存関係をインストールし、Pythonをインストールし、インストールしたら次のコマンドを使用します。

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

4. 構成ファイルを編集して、コードリポジトリをポイントします。
   1. docs_path：目的のドキュメントフォルダーへの相対パス（構成ファイルのmkdocsと一致するはずです）。
   2. root_dir：目的のプロジェクトルートディレクトリへの絶対パスまたは相対パス。
   3. source_to_document：
      • ルートディレクトリに解析および文書化したいフォルダーへの絶対パスまたは相対パス。
   4. 要件：ドキュメントをコードサイトとして実行するためのPython依存関係のリスト。
      • MKDOCS：1.4.2
      • Pymdown-Extensions：9.11
   5. Ingrore_Folders：無視するフォルダー/サブフォルダーの正規表現のリスト。必要に応じて削除します。
      • 。+。git
      • .pytest
      • 含む
      • lib
      • スクリプト
   6. Ingrore_files：無視するファイルの正規表現のリスト。必要に応じて削除します。
      • 。*
      • ^（？！。. py $）。
   7. use_state：ブール値、これにより、各実行時にファイルが再生されないようになります。ドキュメントを更新する場合は、自由にオフにしてください。
5. 次のコマンドを実行して、コードのドキュメントを生成します。

 python Auto_Doc.py

これにより、GPT-3.5言語モデルを使用して、コードベースのドキュメントを生成し、構成されたdocsディレクトリのマークダウンファイルとして生成されたドキュメントを出力します。

1. 静的サイトジェネレーターMKDOCSを実行して、生成されたドキュメントを「コードとしてドキュメント」サイトに変換します。

たとえば、mkdocsを使用するには、ルートディレクトリで次のコマンドを実行してサイトをプレビューします。

 mkdocs serve

または、MKDOCを使用してサイトを構築します。

 mkdocs build

これにより、 siteディレクトリに静的Webサイトが生成され、サーバーまたはGitHubページのようなサービスをホストできます。

githubページでホストしたい場合。 githubアクションをセットアップして、コードサイトmkdocsとしてドキュメントを自動化することができます。

 mkdocs gh-deploy

貢献

このリポジトリに貢献したい場合は、プルリクエストまたは問題を自由に開いてください。コードのフィードバック、提案、または改善を歓迎します。

ライセンス

このリポジトリは、MITライセンスの下でライセンスされています。詳細については、 LICENSEファイルを参照してください。