Code Monkey home page Code Monkey logo

docgen's Introduction

Docgen

This IntelliJ plugin allows you to generate Python function documentation using OpenAI's ChatGPT.

Features

  • Generate code documentation using OpenAI's gpt-3.5-turbo model
  • Option to use a custom prompt

Installation

  1. Open IntelliJ IDEA
  2. Make sure that the Python plugin is installed
  3. Go to Preferences
  4. Select Plugins
  5. Click on Marketplace and search for Docgen
  6. Install the plugin and restart IntelliJ IDEA

Configuration

  1. To set your OpenAI API key, go to Preferences > Tools > Docgen
  2. Enter your API key in the provided input field and click 'Apply'
  3. Set your keyboard shortcut: go to Preferences > Keymap and look for Plugins > Docgen > Generate docstring

Usage

  1. Right-click on the function you want to generate documentation for
  2. Choose Generate docstring from the context menu
  3. Wait for the OpenAI model to generate the documentation
  4. The generated documentation will be displayed in a popup window
  5. Click Insert to add the documentation to your Python function

Prompt

The default prompt is:

Generate high-quality docstring for the following Python function including function signature:

To use a custom prompt, go to Preferences > Tools > Docgen and enter your prompt in the provided input field.

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.

docgen's People

Contributors

martasd avatar msvana avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.