skills.rest
benthamite
benthamiteCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-elisp

Generate and update Emacs Lisp package documentation in .org format.

9|1|Updated Jul 19, 2022
Search Tags:#documentation#org-mode#emacs#package development#elisp#texinfo
One-click install
npx skills add https://github.com/benthamite/dotfiles --skill doc-elisp
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-elisp
Source: https://github.com/benthamite/dotfiles/tree/main/claude/skills/doc-elisp
Command: npx skills add https://github.com/benthamite/dotfiles --skill doc-elisp

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation and updating of comprehensive documentation for Emacs Lisp packages, ensuring a consistent, high-quality standard aligned with established best practices.

Core Features & Use Cases

  • Automated Documentation Generation: Creates or updates .org files for Elisp packages, adhering to a specific manual style.
  • Definition Extraction: Identifies and documents user options, public variables, commands, and public functions from .el files.
  • Structural Analysis: Compares existing documentation with source code to identify additions, removals, or changes in definitions.
  • Use Case: You have developed a new Emacs Lisp package and need to create its official documentation, including an overview, user options, commands, and functions, formatted according to a rigorous standard.

Quick Start

Use the doc-elisp skill to create or update the documentation for the 'my-package.el' file.

Frequently Asked Questions about doc-elisp

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for an Emacs Lisp package?▼

To generate Emacs Lisp documentation, this Skill extracts user options, variables, and public functions from `.el` source files to create structured `.org` manuals automatically.

Can I use org-mode to document user options and commands in Elisp packages?▼

Yes, you can document user options and commands by generating `.org` files that follow the Denote manual style, ensuring strict formatting, cross-referencing, and prose quality standards.

What is the best way to update existing Elisp package documentation?▼

Updating Elisp documentation involves comparing existing `.org` manuals against source code to identify additions, removals, or changes in definitions, then regenerating the affected sections.

Does this documentation tool require Texinfo formatting for Emacs package manuals?▼

No, it generates documentation in `.org` format rather than Texinfo, specifically adhering to the Denote manual style for Emacs Lisp package development.

How do you extract public functions and variables from `.el` files for documentation?▼

Extraction works by analyzing Elisp source files to identify and structure public functions, interactive commands, and variables, then mapping them into a formatted `.org` manual.

Related Skills

Explore More Software Engineering Skills→
moogahmoogah

emacs-literate-programming

Tangle .org Emacs configuration sources into generated .el files.

Community
Intermediate
plurigridplurigrid
60

emacs-info

Navigate and query Emacs Info manuals for Emacs, Elisp, and GNU tools.

Official
Intermediate
plurigridplurigrid
60

emacs

Configure Emacs with elisp, org, gnus, tramp, and eglot.

Official
Advanced
takeokunntakeokunn
71

Emacs Ecosystem

Standardize Emacs Lisp configuration patterns for Emacs 29+ ecosystems.

Community
Advanced