metadata

title: TechdocsAPI
emoji: 🐢
colorFrom: green
colorTo: green
sdk: docker
pinned: false

Techdocs: A code documentation generator

Introduction

Code Documentation Generation is a tool that generates documentation for your code. It is a simple tool that can be used by anyone who wants to generate documentation for their code. It leverages the power of OpenAI GPT-3, Huggingface Transformers, Langchain and Clarifai to generate documentation for your code.

To use the application, you need to provide your code as input. The tool will analyze your code and generate documentation for it. The documentation will include comments, descriptions, parameters, return values, examples, and more.

It is a useful tool for developers who want to document their code without spending too much time and effort. It can help you improve the readability, maintainability, and quality of your code. It can also help you share your code with others more easily.

Installation

Download zip or Clone the repository and run the following command in the terminal to install the required packages.

We recommend using a virtual environment for the installation.

$ git clone https://github.com/HemanthSai7/Techdocs
$ cd Techdocs
$ pip install -r requirements.txt
$ -- Run backend
$ uvicorn app:app --reload

Tech Stack Used

Team Members

Name	Github
Mayuresh Agashe	Mayuresh Agashe
Hemanth Sai Garladinne	Hemanth Sai Garladinne