This python module will take in your source directory, read through your python/java files, and generate documentation for it.
pip install .Important: This project assumes your project structure is the following:
.
|-- src
| |-- {YOUR PROJECT}
| |-- example.py
|-- pyproject.toml
|-- .env.secret(AI HOST + MODEL)
|-- .env.shared(OPTIONAL: Used If Unable To Get Project Data from pyproject.toml)
|
| **File Structure Below Is Auto Generated**
|-- docs
| |-- index.html
| |-- {YOUR PROJECT}
| |-- example.py.htmlDefine .env.secret file
- Create File
touch .env.secret- Define the variables
AI_HOST="{URL_ENDPOINT}"
MODEL="{MODEL: Ex. codegemma:instruct}"
OPTIONAL: Define .env.shared file This file is used for metadata if we are unable to get it from pyproject.toml
- Create File
touch .env.shared- Define the variables
PROJECT_NAME={PROJECT_NAME}
PROJECT_VERSION={PROJECT_VERSION}
Running Documentation Generator:
python3 -m DocumentationGeneratorImportant: This project assumes your project structure is the following:
.
|-- src
| |-- {YOUR PROJECT}
| |-- example.java
|-- .env.secret(AI HOST + MODEL)
|-- .env.shared(Requried for Project Metadata)
|
| **File Structure Below Is Auto Generated**
|-- docs
| |-- index.html
| |-- {YOUR PROJECT}
| |-- example.java.html
Define .env.secret file
- Create File
touch .env.secret- Define the variables
AI_HOST="{URL_ENDPOINT}"
MODEL="{MODEL: Ex. codegemma:instruct}"
Define .env.shared file This file is used for metadata
- Create File
touch .env.shared- Define the variables
PROJECT_NAME={PROJECT_NAME}
PROJECT_VERSION={PROJECT_VERSION}
Running Documentation Generator:
python3 -m DocumentationGeneratorPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.