Skip to content
BranchesTags

Repository files navigation

Docgen

This IntelliJ plugin allows you to generate Python function documentation using OpenAI's ChatGPT.
You can download the plugin from the JetBrains MarketPlace - Docgen

Features

  • Generate code documentation using OpenAI's models
  • 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

Model

The default model is gpt-3.5-turbo. To use another model go to Preferences > Tools > Docgen and enter the model name in the provided input field.

Prompt

The default prompt is:

Generatehigh-qualitydocstringforthefollowingPythonfunctionincludingfunctionsignature:

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

Development environment

We recommend using IntelliJ IDEA for development. After installing IDEA you can simply open the project folder.

You also need JDK 17. If IDEA can't find this JDK version on your machine it should suggest downloading it for you after opening any .java file. You can also go to File > New > Project > JDK > Add SDK and download the correct JDK version manually.

To test the plugin you go to Run > Run... and select the Run Plugin configuration. This will start a new isolated IDEA instance with Docgen already installed.

To create a ZIP file for distributing the plugin first open the Gradle tool window by clicking View > Tool Windows > Gradle. Then select Tasks > intelij > buildPlugin. If the Gradle tool window is empty click the "reload" button. It will force IDEA to download all missing tools.

Contributing

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

About

IntelliJ plugin to generate Python documentation using OpenAI's GPT model

Topics

chatgptintellij-pluginpycharmpycharm-pluginpython

Resources

Readme
Activity
Custom properties

Stars

2 stars

Watchers

5 watching

Forks

4 forks
Report repository

Releases

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - profiq/docgen: IntelliJ plugin to generate Python documentation using OpenAI's GPT model · GitHub
Skip to content
BranchesTags
Repository files navigation
Docgen
This IntelliJ plugin allows you to generate Python function documentation using OpenAI's ChatGPT.

You can download the plugin from the JetBrains MarketPlace - Docgen
Features
  • Generate code documentation using OpenAI's models
  • 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
Model
The default model is gpt-3.5-turbo. To use another model go to Preferences > Tools > Docgen and
enter the model name in the provided input field.
Prompt
The default prompt is:
Generatehigh-qualitydocstringforthefollowingPythonfunctionincludingfunctionsignature:
To use a custom prompt, go to Preferences > Tools > Docgen and enter your prompt in the provided input field.
Development environment
We recommend using IntelliJ IDEA for development. After installing IDEA you can simply open the project folder.
You also need JDK 17. If IDEA can't find this JDK version on your machine it should
suggest downloading it for you after opening any .java file. You can also go to File > New > Project > JDK > Add SDK
and download the correct JDK version manually.
To test the plugin you go to Run > Run... and select the Run Plugin configuration. This will start a new isolated IDEA
instance with Docgen already installed.
To create a ZIP file for distributing the plugin first open the Gradle tool window by clicking View > Tool Windows > Gradle.
Then select Tasks > intelij > buildPlugin. If the Gradle tool window is empty click the "reload" button. It will force
IDEA to download all missing tools.
Contributing
Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.
About
IntelliJ plugin to generate Python documentation using OpenAI's GPT model
Topics
chatgptintellij-pluginpycharmpycharm-pluginpython
Resources
Readme
Activity
Custom properties
Stars
2 stars
Watchers
5 watching
Forks
4 forks
Report repository
Releases
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - profiq/docgen: IntelliJ plugin to generate Python documentation using OpenAI's GPT model · GitHub
Skip to content
BranchesTags
Repository files navigation
Docgen
This IntelliJ plugin allows you to generate Python function documentation using OpenAI's ChatGPT.

You can download the plugin from the JetBrains MarketPlace - Docgen
Features
  • Generate code documentation using OpenAI's models
  • 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
Model
The default model is gpt-3.5-turbo. To use another model go to Preferences > Tools > Docgen and
enter the model name in the provided input field.
Prompt
The default prompt is:
Generatehigh-qualitydocstringforthefollowingPythonfunctionincludingfunctionsignature:
To use a custom prompt, go to Preferences > Tools > Docgen and enter your prompt in the provided input field.
Development environment
We recommend using IntelliJ IDEA for development. After installing IDEA you can simply open the project folder.
You also need JDK 17. If IDEA can't find this JDK version on your machine it should
suggest downloading it for you after opening any .java file. You can also go to File > New > Project > JDK > Add SDK
and download the correct JDK version manually.
To test the plugin you go to Run > Run... and select the Run Plugin configuration. This will start a new isolated IDEA
instance with Docgen already installed.
To create a ZIP file for distributing the plugin first open the Gradle tool window by clicking View > Tool Windows > Gradle.
Then select Tasks > intelij > buildPlugin. If the Gradle tool window is empty click the "reload" button. It will force
IDEA to download all missing tools.
Contributing
Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.
About
IntelliJ plugin to generate Python documentation using OpenAI's GPT model
Topics
chatgptintellij-pluginpycharmpycharm-pluginpython
Resources
Readme
Activity
Custom properties
Stars
2 stars
Watchers
5 watching
Forks
4 forks
Report repository
Releases
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - profiq/docgen: IntelliJ plugin to generate Python documentation using OpenAI's GPT model · GitHub
Skip to content
BranchesTags
Repository files navigation
Docgen
This IntelliJ plugin allows you to generate Python function documentation using OpenAI's ChatGPT.

You can download the plugin from the JetBrains MarketPlace - Docgen
Features
  • Generate code documentation using OpenAI's models
  • 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
Model
The default model is gpt-3.5-turbo. To use another model go to Preferences > Tools > Docgen and
enter the model name in the provided input field.
Prompt
The default prompt is:
Generatehigh-qualitydocstringforthefollowingPythonfunctionincludingfunctionsignature:
To use a custom prompt, go to Preferences > Tools > Docgen and enter your prompt in the provided input field.
Development environment
We recommend using IntelliJ IDEA for development. After installing IDEA you can simply open the project folder.
You also need JDK 17. If IDEA can't find this JDK version on your machine it should
suggest downloading it for you after opening any .java file. You can also go to File > New > Project > JDK > Add SDK
and download the correct JDK version manually.
To test the plugin you go to Run > Run... and select the Run Plugin configuration. This will start a new isolated IDEA
instance with Docgen already installed.
To create a ZIP file for distributing the plugin first open the Gradle tool window by clicking View > Tool Windows > Gradle.
Then select Tasks > intelij > buildPlugin. If the Gradle tool window is empty click the "reload" button. It will force
IDEA to download all missing tools.
Contributing
Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.
About
IntelliJ plugin to generate Python documentation using OpenAI's GPT model
Topics
chatgptintellij-pluginpycharmpycharm-pluginpython
Resources
Readme
Activity
Custom properties
Stars
2 stars
Watchers
5 watching
Forks
4 forks
Report repository
Releases
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
GitHub - profiq/docgen: IntelliJ plugin to generate Python documentation using OpenAI's GPT model · GitHub
Skip to content
BranchesTags
Repository files navigation
Docgen
This IntelliJ plugin allows you to generate Python function documentation using OpenAI's ChatGPT.

You can download the plugin from the JetBrains MarketPlace - Docgen
Features
  • Generate code documentation using OpenAI's models
  • 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
Model
The default model is gpt-3.5-turbo. To use another model go to Preferences > Tools > Docgen and
enter the model name in the provided input field.
Prompt
The default prompt is:
Generatehigh-qualitydocstringforthefollowingPythonfunctionincludingfunctionsignature:
To use a custom prompt, go to Preferences > Tools > Docgen and enter your prompt in the provided input field.
Development environment
We recommend using IntelliJ IDEA for development. After installing IDEA you can simply open the project folder.
You also need JDK 17. If IDEA can't find this JDK version on your machine it should
suggest downloading it for you after opening any .java file. You can also go to File > New > Project > JDK > Add SDK
and download the correct JDK version manually.
To test the plugin you go to Run > Run... and select the Run Plugin configuration. This will start a new isolated IDEA
instance with Docgen already installed.
To create a ZIP file for distributing the plugin first open the Gradle tool window by clicking View > Tool Windows > Gradle.
Then select Tasks > intelij > buildPlugin. If the Gradle tool window is empty click the "reload" button. It will force
IDEA to download all missing tools.
Contributing
Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.
About
IntelliJ plugin to generate Python documentation using OpenAI's GPT model
Topics
chatgptintellij-pluginpycharmpycharm-pluginpython
Resources
Readme
Activity
Custom properties
Stars
2 stars
Watchers
5 watching
Forks
4 forks
Report repository
Releases
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - profiq/docgen: IntelliJ plugin to generate Python documentation using OpenAI's GPT model · GitHub
Skip to content
BranchesTags
Repository files navigation
Docgen
This IntelliJ plugin allows you to generate Python function documentation using OpenAI's ChatGPT.

You can download the plugin from the JetBrains MarketPlace - Docgen
Features
  • Generate code documentation using OpenAI's models
  • 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
Model
The default model is gpt-3.5-turbo. To use another model go to Preferences > Tools > Docgen and
enter the model name in the provided input field.
Prompt
The default prompt is:
Generatehigh-qualitydocstringforthefollowingPythonfunctionincludingfunctionsignature:
To use a custom prompt, go to Preferences > Tools > Docgen and enter your prompt in the provided input field.
Development environment
We recommend using IntelliJ IDEA for development. After installing IDEA you can simply open the project folder.
You also need JDK 17. If IDEA can't find this JDK version on your machine it should
suggest downloading it for you after opening any .java file. You can also go to File > New > Project > JDK > Add SDK
and download the correct JDK version manually.
To test the plugin you go to Run > Run... and select the Run Plugin configuration. This will start a new isolated IDEA
instance with Docgen already installed.
To create a ZIP file for distributing the plugin first open the Gradle tool window by clicking View > Tool Windows > Gradle.
Then select Tasks > intelij > buildPlugin. If the Gradle tool window is empty click the "reload" button. It will force
IDEA to download all missing tools.
Contributing
Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.
About
IntelliJ plugin to generate Python documentation using OpenAI's GPT model
Topics
chatgptintellij-pluginpycharmpycharm-pluginpython
Resources
Readme
Activity
Custom properties
Stars
2 stars
Watchers
5 watching
Forks
4 forks
Report repository
Releases
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
GitHub - profiq/docgen: IntelliJ plugin to generate Python documentation using OpenAI's GPT model · GitHub
Skip to content
BranchesTags
Repository files navigation
Docgen
This IntelliJ plugin allows you to generate Python function documentation using OpenAI's ChatGPT.

You can download the plugin from the JetBrains MarketPlace - Docgen
Features
  • Generate code documentation using OpenAI's models
  • 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
Model
The default model is gpt-3.5-turbo. To use another model go to Preferences > Tools > Docgen and
enter the model name in the provided input field.
Prompt
The default prompt is:
Generatehigh-qualitydocstringforthefollowingPythonfunctionincludingfunctionsignature:
To use a custom prompt, go to Preferences > Tools > Docgen and enter your prompt in the provided input field.
Development environment
We recommend using IntelliJ IDEA for development. After installing IDEA you can simply open the project folder.
You also need JDK 17. If IDEA can't find this JDK version on your machine it should
suggest downloading it for you after opening any .java file. You can also go to File > New > Project > JDK > Add SDK
and download the correct JDK version manually.
To test the plugin you go to Run > Run... and select the Run Plugin configuration. This will start a new isolated IDEA
instance with Docgen already installed.
To create a ZIP file for distributing the plugin first open the Gradle tool window by clicking View > Tool Windows > Gradle.
Then select Tasks > intelij > buildPlugin. If the Gradle tool window is empty click the "reload" button. It will force
IDEA to download all missing tools.
Contributing
Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.
About
IntelliJ plugin to generate Python documentation using OpenAI's GPT model
Topics
chatgptintellij-pluginpycharmpycharm-pluginpython
Resources
Readme
Activity
Custom properties
Stars
2 stars
Watchers
5 watching
Forks
4 forks
Report repository
Releases
Used by
Contributors
Languages