About

Generate documentation for Elisp packages.

Table of Contents

• About
• Installation
  • With use-package and ~straight~
  • Manual installation
• Usage
  • Commands

Installation

Name	Version
Emacs	28.1
org	9.5.5

With use-package and straight

(use-package org-autodoc
  :straight (org-autodoc
             :repo "KarimAziev/org-autodoc"
             :type git
             :host github)
  :commands (org-autodoc-insert-doc-string
             org-autodoc-async
             org-autodoc-insert-use-package))

Manual installation

Download the source code and put it wherever you like, e.g. into ~/.emacs.d/org-autodoc/

git clone https://github.com/KarimAziev/org-autodoc.git ~/.emacs.d/org-autodoc/

Add the downloaded directory to the load path:

(add-to-list 'load-path "~/.emacs.d/org-autodoc/")
(require 'org-autodoc)

Usage

Commands

org-autodoc-insert-doc-string

Inside function without documentation string, insert documentation template.

org-autodoc-async

Load current file in new emacs process and generate documentation for it.

org-autodoc-insert-use-package (library)

Insert use-package skeleton for library.