MkAutoDocs

GPT-3.5 코드 문서 저장소

이 저장소는 코드에 대한 문서를 자동으로 생성하기 위해 OpenAI의 GPT-3.5 언어 모델의 사용을 보여줍니다. 그런 다음 생성 된 문서는 쉽게 액세스하고 공유 할 수 있도록 "코드"사이트로 전환됩니다.

시작하기

이 저장소를 사용하려면 다음이 필요합니다.

• 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 : 원하는 doc 폴더에 대한 상대 경로 (구성 파일의 mkdocs와 일치해야 함).
   2. root_dir : 원하는 프로젝트 루트 디렉토리에 대한 절대 경로 또는 상대 경로.
   3. source_to_document :
      • 루트 디렉토리에 구문 분석하고 문서화하려는 폴더에 대한 절대 경로 또는 상대 경로.
   4. 요구 사항 : 코드 사이트로 문서를 실행하기위한 파이썬 종속성 목록.
      • MKDOCS : 1.4.2
      • Pymdown-Extensions : 9.11
   5. INGORE_FOLDERS : 무시할 폴더/서브 폴더의 정면 목록. 원하는 경우 또는 전부를 제거하십시오.
      • .+. git
      • .pytest
      • 포함하다
      • lib
      • 스크립트
   6. INGORE_FILES : 무시할 파일의 정면 목록. 원하는 경우 또는 전부를 제거하십시오.
      • .*
      • ^(?! .. .py $).
   7. USE_STATE : 부울 값으로,마다 파일이 재생되지 않도록합니다. 문서를 업데이트하려면 자유롭게 끄십시오.
5. 코드에 대한 문서를 생성하려면 다음 명령을 실행하십시오.

 python Auto_Doc.py

이렇게하면 GPT-3.5 언어 모델을 사용하여 코드베이스에 대한 문서를 생성하고 구성된 docs 디렉토리의 마크 다운 파일로 생성 된 문서를 출력합니다.

1. 정적 사이트 생성기 MKDocs를 실행하여 생성 된 문서를 "코드"사이트로 바꾸십시오.

예를 들어, MKDocs를 사용하려면 루트 디렉토리에서 다음 명령을 실행하여 사이트를 미리 봅니다.

 mkdocs serve

또는 MKDOC를 사용하여 사이트를 구축하십시오.

 mkdocs build

이는 site 디렉토리에서 정적 웹 사이트를 생성하며 서버 또는 GitHub 페이지와 같은 서비스에서 호스팅 할 수 있습니다.

GitHub 페이지에서 호스팅하려는 경우. 문서를 코드 사이트 MKDocs로 자동 배포하기 위해 github 조치를 설정할 수 있습니다.

 mkdocs gh-deploy

기여

이 저장소에 기여하려면 풀 요청이나 문제를 자유롭게 열어주십시오. 우리는 코드의 피드백, 제안 또는 개선을 환영합니다.

특허

이 저장소는 MIT 라이센스에 따라 라이센스가 부여됩니다. 자세한 내용은 LICENSE 파일을 참조하십시오.