I have basically nuked this but GPT still likes to do funky shit with docstrings
November 5, 2026 at 11:07 PM
I have basically nuked this but GPT still likes to do funky shit with docstrings
🐧 **pdoc – Python API documentation generator**
pdoc generates Python API documentation from docstrings and type annotations, with live previews, Markdown support, and custom templates.
📰 Source: LinuxLinks
🔗 Link: https://www.linuxlinks.com/pdoc-python-api-documentation-generator/
#python
pdoc generates Python API documentation from docstrings and type annotations, with live previews, Markdown support, and custom templates.
📰 Source: LinuxLinks
🔗 Link: https://www.linuxlinks.com/pdoc-python-api-documentation-generator/
#python
pdoc – Python API documentation generator
pdoc generates Python API documentation from docstrings and type annotations, with live previews, Markdown support, and custom templates.
The post pdoc – Python API documentation generator appeared first on LinuxLinks.
www.linuxlinks.com
November 9, 2026 at 2:24 AM
🐧 **pdoc – Python API documentation generator**
pdoc generates Python API documentation from docstrings and type annotations, with live previews, Markdown support, and custom templates.
📰 Source: LinuxLinks
🔗 Link: https://www.linuxlinks.com/pdoc-python-api-documentation-generator/
#python
pdoc generates Python API documentation from docstrings and type annotations, with live previews, Markdown support, and custom templates.
📰 Source: LinuxLinks
🔗 Link: https://www.linuxlinks.com/pdoc-python-api-documentation-generator/
#python
🐧 **pdoc – Python API documentation generator**
pdoc generates Python API documentation from docstrings and type annotations, with live previews, Markdown support, and custom templates.
📰 Source: LinuxLinks
🔗 Link: https://www.linuxlinks.com/pdoc-python-api-documentation-generator/
#python
pdoc generates Python API documentation from docstrings and type annotations, with live previews, Markdown support, and custom templates.
📰 Source: LinuxLinks
🔗 Link: https://www.linuxlinks.com/pdoc-python-api-documentation-generator/
#python
pdoc – Python API documentation generator
pdoc generates API documentation from Python modules, docstrings, and type annotations. Its output follows the project’s module hierarchy, providing a reference for packages, classes, functions, and variables.
A built-in web server previews documentation during development, while HTML export produces files suitable for publishing on a static web host.
This is free and open source software.
#### Key Features
* Generates documentation directly from Python projects with minimal initial configuration.
* Interprets Markdown in docstrings, including formatted text, links, lists, and code examples.
* Understands NumPy-style and Google-style docstrings for documenting parameters, return values, and other details.
* Displays type annotations and resolves forward references expressed as strings.
* Automatically links recognized identifiers to their corresponding documentation.
* Extracts variable documentation and annotations, including instance attributes declared in constructors.
* Inherits documentation and type annotations for class members where appropriate.
* Uses module exports and visibility controls to determine which objects appear in the documentation.
* Allows selected submodules to be excluded and documented items to be reordered.
* Provides a development server with automatic reloading as source files change.
* Exports self-contained HTML documentation without requiring pdoc on the hosting server.
* Supports mathematical notation, Mermaid diagrams, and included Markdown files.
* Offers customizable Jinja2 templates, project logos, and documentation title pages.
* Provides a Python API for integrating documentation generation into other tools.
* Cross-platform support – runs on Linux, macOS, and Windows.
**Website:** **github.com/mitmproxy/pdoc**
**Support:**
**Developer:** Maximilian Hils and contributors
**License:** MIT No Attribution License
pdoc is written in Python. Learn Python with our recommended **free books** and **free tutorials**.
* * *
#### Related Software
**Documentation Generators**
---
**JSDoc**| API documentation generator for JavaScript
**Javadoc**| Generate API documentation in HTML format
**Sphinx**| Create intelligent and beautiful documentation for Python projects
**phpDocumentor**| Complete documentation solution for PHP
**Doxygen**| Documentation system for C, C++, Java, Python and other languages
**Docusaurus**| Build, deploy and maintain documentation websites
**mdBook**| Create modern online books from Markdown files
**YARD**| Ruby documentation tool
**Starlight**| Documentation website framework
**Docco**| Literate-programming-style documentation generator
**Natural Docs**| Documentation generator that supports 21 different languages
**Quarto**| Scientific and technical publishing system
**Antora**| Modular documentation site generator
**Crycco**| Quick and dirty documentation generator
**ROBODoc**| Documentation tool similar to Javadoc
Read our verdict in the **software roundup**.
* * *
LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of **recommended applications** , including alternatives to popular proprietary software.
We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our **Linux resources** to discover more.
Know a useful free and open source Linux application we haven't covered? **Suggest a program** for inclusion.
Has your software been featured on LinuxLinks? Display one of our **Featured on LinuxLinks badges** on your website or GitHub README.
---
www.linuxlinks.com
November 7, 2026 at 2:20 AM
🐧 **pdoc – Python API documentation generator**
pdoc generates Python API documentation from docstrings and type annotations, with live previews, Markdown support, and custom templates.
📰 Source: LinuxLinks
🔗 Link: https://www.linuxlinks.com/pdoc-python-api-documentation-generator/
#python
pdoc generates Python API documentation from docstrings and type annotations, with live previews, Markdown support, and custom templates.
📰 Source: LinuxLinks
🔗 Link: https://www.linuxlinks.com/pdoc-python-api-documentation-generator/
#python
🐧 **docformatter – automatic formatter for Python docstrings**
docformatter formats Python docstrings according to PEP 257, with configurable wrapping, style support and automated code quality checks.
📰 Source: LinuxLinks
🔗 Link […]
docformatter formats Python docstrings according to PEP 257, with configurable wrapping, style support and automated code quality checks.
📰 Source: LinuxLinks
🔗 Link […]
Original post on igeek.gamer-geek-news.com
igeek.gamer-geek-news.com
November 3, 2026 at 11:23 PM
🐧 **docformatter – automatic formatter for Python docstrings**
docformatter formats Python docstrings according to PEP 257, with configurable wrapping, style support and automated code quality checks.
📰 Source: LinuxLinks
🔗 Link […]
docformatter formats Python docstrings according to PEP 257, with configurable wrapping, style support and automated code quality checks.
📰 Source: LinuxLinks
🔗 Link […]
Same 112 tool descriptions and schemas in both modes. MCP used JSON. Code mode used Python docstrings. Direct ran with --tools set to empty. Code mode had Bash, Read, Write, Glob and Grep. The prompts differed between runs.
November 6, 2026 at 7:00 PM
Same 112 tool descriptions and schemas in both modes. MCP used JSON. Code mode used Python docstrings. Direct ran with --tools set to empty. Code mode had Bash, Read, Write, Glob and Grep. The prompts differed between runs.
🐧 **docformatter – automatic formatter for Python docstrings**
docformatter formats Python docstrings according to PEP 257, with configurable wrapping, style support and automated code quality checks.
📰 Source: LinuxLinks
🔗 Link […]
docformatter formats Python docstrings according to PEP 257, with configurable wrapping, style support and automated code quality checks.
📰 Source: LinuxLinks
🔗 Link […]
Original post on igeek.gamer-geek-news.com
igeek.gamer-geek-news.com
November 1, 2026 at 11:16 PM
🐧 **docformatter – automatic formatter for Python docstrings**
docformatter formats Python docstrings according to PEP 257, with configurable wrapping, style support and automated code quality checks.
📰 Source: LinuxLinks
🔗 Link […]
docformatter formats Python docstrings according to PEP 257, with configurable wrapping, style support and automated code quality checks.
📰 Source: LinuxLinks
🔗 Link […]
The first mindblowing thing i experienced was GitHub copilot preview basically writing an entire ticker history script from just function names and docstrings.
November 1, 2026 at 7:42 PM
The first mindblowing thing i experienced was GitHub copilot preview basically writing an entire ticker history script from just function names and docstrings.
The model wasn't lazy; the parser was too rigid without context. Use a lightweight LLM with system prompts to auto-generate docstrings from raw docs, bypassing its refusal wall entirely.
November 1, 2026 at 1:24 PM
The model wasn't lazy; the parser was too rigid without context. Use a lightweight LLM with system prompts to auto-generate docstrings from raw docs, bypassing its refusal wall entirely.
do you want the actual .py? it's quick lab notebook slopcode but it's got okay docstrings.
October 26, 2026 at 5:31 PM
do you want the actual .py? it's quick lab notebook slopcode but it's got okay docstrings.
🐍 Python Term of the Day: doctest (Python Standard Library)
Provides tools for testing your code by running tests embedded in docstrings.
Provides tools for testing your code by running tests embedded in docstrings.
realpython.com
October 24, 2026 at 2:41 PM
🐍 Python Term of the Day: doctest (Python Standard Library)
Provides tools for testing your code by running tests embedded in docstrings.
Provides tools for testing your code by running tests embedded in docstrings.
Agree. The servers that last for me have 3 tools with clear docstrings, not 40 vague ones. Wrote up how I build them: www.intellinode.ai/articles/bui...
October 23, 2026 at 7:34 PM
Agree. The servers that last for me have 3 tools with clear docstrings, not 40 vague ones. Wrote up how I build them: www.intellinode.ai/articles/bui...
Want an AI agent to follow your project's rules? Tests first, docstrings, docs updated before every commit?
In Codex for Python Developers, you'll write an AGENTS.md file that tells Codex CLI how your project works. Live, November 7–8:
realpython.com/workshops/co...
In Codex for Python Developers, you'll write an AGENTS.md file that tells Codex CLI how your project works. Live, November 7–8:
realpython.com/workshops/co...
October 22, 2026 at 10:01 PM
Want an AI agent to follow your project's rules? Tests first, docstrings, docs updated before every commit?
In Codex for Python Developers, you'll write an AGENTS.md file that tells Codex CLI how your project works. Live, November 7–8:
realpython.com/workshops/co...
In Codex for Python Developers, you'll write an AGENTS.md file that tells Codex CLI how your project works. Live, November 7–8:
realpython.com/workshops/co...
Best way I've found to give agents my own APIs without glue code. Small typed tools, clear docstrings, done: www.intellinode.ai/articles/bui...
October 21, 2026 at 6:37 PM
Best way I've found to give agents my own APIs without glue code. Small typed tools, clear docstrings, done: www.intellinode.ai/articles/bui...
it's been really fucking with me that software folks have been shit at docs for 50 years but as soon as the llms need it, they're champing at the bit to write the best docs possible. suddenly, i know all of the intentions and edge cases the devs anticipated, all of the docstrings they left off.
October 20, 2026 at 4:52 PM
it's been really fucking with me that software folks have been shit at docs for 50 years but as soon as the llms need it, they're champing at the bit to write the best docs possible. suddenly, i know all of the intentions and edge cases the devs anticipated, all of the docstrings they left off.
🐍📰 How to Use Claude Code Skills for Better Python Docstrings
realpython.com
October 20, 2026 at 3:11 PM
🐍📰 How to Use Claude Code Skills for Better Python Docstrings
they’ll drag you for this but you’re right… it’s classic extreme internet simplification. is using it to write docstrings or unit tests the exact same as an LLM generated movie script? one is obviously worse than the other but it all gets flattened, which makes the latter seem LESS bad
October 19, 2026 at 1:36 PM
they’ll drag you for this but you’re right… it’s classic extreme internet simplification. is using it to write docstrings or unit tests the exact same as an LLM generated movie script? one is obviously worse than the other but it all gets flattened, which makes the latter seem LESS bad
Chthulhu Python: all your code has been written for eons, and is just waiting to be woken up.
Most developers can only add paragraphs and paragraphs of tales, I mean docstrings, and barely get to actually do anything.
There's also a new "panic" key words […]
[Original post on fosstodon.org]
Most developers can only add paragraphs and paragraphs of tales, I mean docstrings, and barely get to actually do anything.
There's also a new "panic" key words […]
[Original post on fosstodon.org]
October 18, 2026 at 12:21 PM
Chthulhu Python: all your code has been written for eons, and is just waiting to be woken up.
Most developers can only add paragraphs and paragraphs of tales, I mean docstrings, and barely get to actually do anything.
There's also a new "panic" key words […]
[Original post on fosstodon.org]
Most developers can only add paragraphs and paragraphs of tales, I mean docstrings, and barely get to actually do anything.
There's also a new "panic" key words […]
[Original post on fosstodon.org]
Tried a flat ban. The agent obeys, then hides its reasoning in identifier names and commit subjects, worse than the docstring it skipped. What stuck: scope by audience. Docstrings and README rationale I write myself, the agent restates only checkable facts. Your manual step is the real lever.
October 11, 2026 at 9:24 AM
Tried a flat ban. The agent obeys, then hides its reasoning in identifier names and commit subjects, worse than the docstring it skipped. What stuck: scope by audience. Docstrings and README rationale I write myself, the agent restates only checkable facts. Your manual step is the real lever.
TBH the more I think about it the more I think this is a good idea. i.e. require a manual step where a human has to go in and add the comments/docstrings/etc they think are necessary. Requires them to actually go through everything.
October 10, 2026 at 6:32 PM
TBH the more I think about it the more I think this is a good idea. i.e. require a manual step where a human has to go in and add the comments/docstrings/etc they think are necessary. Requires them to actually go through everything.
Writing good docstrings is something I'm so shitty at, and in principle maybe an LLM could do it, but I think about how I feel when somebody sends me an LLM output when I ask them a question, and so I don't and just keep doing stupid shit like
def do_foo(skub):
"""Does foo on skub"""
def do_foo(skub):
"""Does foo on skub"""
October 9, 2026 at 12:46 PM
Writing good docstrings is something I'm so shitty at, and in principle maybe an LLM could do it, but I think about how I feel when somebody sends me an LLM output when I ask them a question, and so I don't and just keep doing stupid shit like
def do_foo(skub):
"""Does foo on skub"""
def do_foo(skub):
"""Does foo on skub"""
Is it just me or do agents tend to write horrifically useless code comments/docstrings/documentation?
October 8, 2026 at 4:26 AM
Is it just me or do agents tend to write horrifically useless code comments/docstrings/documentation?