docutils/tools/editors/emacs/README.txt

   1 .. -*- coding: utf-8 -*-
   2
   3 =====================
   4  Emacs Support Files
   5 =====================
   6
   7 :Date: $Date$
   8
   9 This directory contains the following Emacs lisp package files:
  10
  11 * `<rst.el>`_: Emacs support for reStructuredText_.  This file contains a
  12   major mode that provides:
  13
  14   * Section decoration/adornment creation and updating (M. Blais);
  15   * Table-of-contents mode and insertion (M. Blais);
  16   * Font-lock syntax highlighting (S. Merten);
  17   * Some handy editing functions (D. Goodger).
  18   * Some functions for converting rest documents from within emacs (M. Blais).
  19
  20 * `<tests/>`_ subdirectory: automated tests for some of the features in rst.el.
  21   Please make sure the tests pass if you change the LISP code.  Just type "make"
  22   to run the tests.
  23
  24 To install the package, put a copy of the package file in a directory on your
  25 ``load-path`` (use ``C-h v load-path`` to check).
  26
  27 For setup and usage details, see `Emacs Support for reStructuredText
  28 <../../../docs/user/emacs.html>`_.
  29
  30 .. _reStructuredText: https://docutils.sourceforge.io/rst.html