This repository has been archived by the owner. It is now read-only.
Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
54 lines (38 sloc) 1.25 KB

sphinxcontrib-emacs — Document Emacs with Sphinx

sphinxcontrib-emacs is a Sphinx extension to document Emacs code.

Features

  • Description directives for Emacs Lisp symbols
  • Autodoc for Emacs Lisp code
  • Better Texinfo integration to build online manuals for Emacs

User Guide

The user guide documents how to use sphinxcontrib-emacs to document your Emacs projects. It starts with an introduction, and a quickstart guide, and then goes on to document each feature of sphinxcontrib-emacs.

.. toctree::
   :maxdepth: 2

   guide/intro
   guide/installation
   guide/quickstart
   guide/domain
   guide/autodoc
   guide/texinfo

Contribute

This section of the documentation explains how to contribute to sphinxcontrib-emacs on Github, and what to keep in mind when reporting issues and opening pull requests.

.. toctree::
   :maxdepth: 2

   contributing

License