neodoc.nvim
A Neovim plugin for generating docstrings with live preview, supporting Google, NumPy, and Sphinx formats.
Overview
NeoDoc.nvim is a Neovim plugin designed to streamline the creation of documentation by automatically generating docstrings for functions and classes. It helps developers maintain consistent documentation across their codebase with minimal effort, currently focusing on Python with plans to expand to JavaScript, TypeScript, Go, and Rust.
Key Features
- Multiple Docstring Styles — Supports Google, NumPy, and Sphinx formats for flexible documentation standards.
- Interactive Template Editor — Provides a split-window interface with live preview as you edit templates.
- Custom Template Support — Allows users to define and save their own docstring templates with placeholders for parameters and return types.
- Language-Agnostic Design — Built to support multiple programming languages, starting with Python.
- Customizable Keybindings — Offers configurable keymaps and commands for seamless integration into your workflow.
Philosophy
NeoDoc.nvim emphasizes developer productivity through an intuitive, interactive interface that makes writing documentation as effortless as writing code, with a focus on extensibility and user customization.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
