🌐
GitHub
github.com › airtai › docstring-gen
GitHub - airtai/docstring-gen: Generator for docstrings · GitHub
docstring-gen is an easy-to-use ... codebase. The library is capable of reading both Jupyter notebooks and Python files, and seamlessly adds meaningful docstrings to classes and functions that lack documentation....
Starred by 19 users
Forked by 5 users
Languages: Jupyter Notebook 78.9% | Python 19.2%
🌐
PyPI
pypi.org › project › docstring-generator
docstring-generator
JavaScript is disabled in your browser. Please enable JavaScript to proceed · A required part of this site couldn’t load. This may be due to a browser extension, network issues, or browser settings. Please check your connection, disable any ad blockers, or try using a different browser
🌐
Python.org
discuss.python.org › python help
Function Docstring Generator - Python Help - Discussions on Python.org
April 12, 2021 - Hey all, there are many tools/packages aimed towards building documentation from code, however I was wondering if someone could point me in the direction of a module designed to automatically generate function docstrings? So something along the lines of def my_func(n: int) -> int: return n*n (now running the module from the commandline) def my_func(n: int) -> int: """[summary placeholder] Args: param1 (int) : [param1 placeholder] Returns: int: [Return value...
🌐
Python
docs.python.org › 3 › library › pydoc.html
pydoc — Documentation generator and online help system ...
If there is no docstring, pydoc tries to obtain a description from the block of comment lines just above the definition of the class, function or method in the source file, or at the top of the module (see inspect.getcomments()). The built-in function help() invokes the online help system in the interactive interpreter, which uses pydoc to generate its documentation as text on the console. The same text documentation can also be viewed from outside the Python interpreter by running pydoc as a script at the operating system’s command prompt.
🌐
Reddit
reddit.com › r/python › automatically generate python docstrings with llms
r/Python on Reddit: Automatically Generate Python Docstrings with LLMs
February 28, 2024 -

Thank you for the all the great feedbacks on my last post.

Context:

What My Project Does?

Penify is a GitHub App that auto-generates and dynamically updates documentation for your repo. It supports various styles like Google, Numpy, reST, and Epydoc, ensuring your documentation stays current with every change.

Check it out: [Penify GitHub App](https://github.com/apps/penify-dev).

Here's how it works in action: [Sample PR](https://github.com/NVIDIA/trt-llm-rag-windows/pull/44/files).

Updates:

  1. Generates consistent style docstrings: Google, reST, Numpy, Epydoc.

  2. Reduces hallucination through improved prompts and more context.

  3. Offers Full Repo documentation generation - previously it used to generate docs for only code changes.

Working on

  • ignore-private

  • ignore-semiprivate

  • ignore-init-method

  • ignore-setters-getters

Target Audience:

  • Ideal for freelance developers requiring high-quality project documentation.

  • Perfect for project managers desiring updated codebase docs for smooth onboarding of new developers.

Alternatives: Copilot & Tabnine Cons:

  1. In consistent style docstring style - sometimes it generates Google,Numpy....

  2. Context selection is very limited in Co-pilot

  3. Need to manually do doc updates for each modified code; Penify does it automatically in the background(it detects code changes and generates docs)

Pros:

  1. You can update the modified docstring before pushing it.

I know the community believes that Docstring generation shouldn't be done by LLMs - but I am seeing some good results. Hence, I am giving my effort. Please try and let me know your feedback.

🌐
Zencoder
zencoder.ai › home › the best docstring generation tools to choose in 2025
The Best Docstring Generation Tools to Choose in 2025
June 2, 2026 - Pdoc is a lightweight, automatic API documentation generator for Python. It creates API documentation by analyzing Python modules and their docstrings, requiring minimal configuration.
Find elsewhere
🌐
GitHub
github.com › topics › docstring-generator
docstring-generator · GitHub Topics · GitHub
Automatic docstring generator that supports and generates a number of specified and widely used docstring style conventions for documentation in Python.
Starred by 125 users
Forked by 12 users
Languages: Python 100.0% | Python 100.0%
🌐
PyPI
pypi.org › project › AIDocStringGenerator
AIDocStringGenerator · PyPI
AIDocStringGenerator is an automated tool that utilizes AI technologies like Anthropic and OpenAI GPT-3.5 to generate and manage docstrings in Python code. It streamlines documentation by processing both single files and entire directories, ...
🌐
Python
wiki.python.org › moin › DocumentationTools
DocumentationTools - Python Wiki
Endo from Enthought Tool Suite - generates HTML API documentation from docstrings and from plain comments that immediately precede variable assignments.
🌐
Hugging Face
huggingface.co › kdf › python-docstring-generation
kdf/python-docstring-generation · Hugging Face
Args: a: the first number to add b: the second number to add Return: The result of a + b """ <|endoftext|> def load_excel(path): return pd.read_excel(path) # docstring """''', return_tensors='pt') doc_max_length = 128 generated_ids = model.generate( **inputs, max_length=inputs.input_ids.shape[1] + doc_max_length, do_sample=False, return_dict_in_generate=True, num_return_sequences=1, output_scores=True, pad_token_id=50256, eos_token_id=50256 # <|endoftext|> ) ret = tokenizer.decode(generated_ids.sequences[0], skip_special_tokens=False) print(ret) inputs = tokenizer('''<|endoftext|> def add(a, b
🌐
GitHub
github.com › paloukari › python-docstring-generator
GitHub - paloukari/python-docstring-generator: A Deep Neural Network that generates docstrings from Python code. Includes code for creating the training corpus.
A Deep Neural Network that generates docstrings from Python code. Includes code for creating the training corpus. - paloukari/python-docstring-generator
Author: paloukari
🌐
Pdoc3
pdoc3.github.io › pdoc
pdoc – Auto-generate API documentation for Python projects
Enter pdoc, the perfect documentation generator for small-to-medium-sized, tidy Python projects. It generates documentation simply from your project's already-existing public modules' and objects' docstrings, like sphinx-apidoc or sphinx.ext.autodoc, but without the hassle of these tools.
🌐
GitHub
github.com › nadeem4 › doc_generator
GitHub - nadeem4/doc_generator: A tool to automatically add docstrings to your Python code using Large Language Models (LLMs), ensuring your code remains unchanged except for the addition of docstrings.
A tool to automatically add docstrings to your Python code using Large Language Models (LLMs), ensuring your code remains unchanged except for the addition of docstrings. Automatic Docstring Generation: Generate comprehensive and descriptive ...
Author: nadeem4
🌐
Medium
medium.com › @peterkong › comparison-of-python-documentation-generators-660203ca3804
Comparison of Python documentation generators | by Peter Kong | Medium
February 22, 2018 - Probably the second-most popular Python-exclusive doc tool (Doxygen is more general) it’s got 373 stars and 12 contributors. Its code is a fraction of Sphinx’s complexity and the output is not quite as polished, but it works with zero configuration in a single step. It also supports docstrings for variables through source code parsing.
🌐
AWS Marketplace
aws.amazon.com › marketplace › pp › prodview-exjekf3tnrxu6
AWS Marketplace: PyDocStrGen: Context-Aware Python Docstring Generator using GenAI
Automate high quality PEP 257 compliant Python docstring generation with PyDocStrGen. This solution uses Amazon Bedrock Inline Agents to intelligently pull context from READMEs or a Bedrock Knowledge Base. It easily process source code archives from S3 and receive documented files back in the ...
Starred by 342 users
Forked by 50 users
Languages: Vim Script 93.6% | Shell 5.2% | Makefile 1.2%