2017-02-02 14:29:45 +00:00
|
|
|
#+TITLE: reStructuredText layer
|
|
|
|
|
|
2019-05-07 08:21:07 +00:00
|
|
|
#+TAGS: dsl|layer|markup|programming
|
2019-05-05 17:26:40 +00:00
|
|
|
|
2017-02-02 14:29:45 +00:00
|
|
|
[[file:img/restructuredtext.png]]
|
|
|
|
|
|
2019-05-07 20:05:06 +00:00
|
|
|
* Table of Contents :TOC_5_gh:noexport:
|
2017-05-22 14:16:12 +00:00
|
|
|
- [[#description][Description]]
|
2017-08-28 21:58:10 +00:00
|
|
|
- [[#features][Features:]]
|
2017-05-22 14:16:12 +00:00
|
|
|
- [[#install][Install]]
|
|
|
|
|
- [[#configuration][Configuration]]
|
|
|
|
|
- [[#auto-complete][Auto-complete]]
|
2017-02-02 14:29:45 +00:00
|
|
|
|
|
|
|
|
* Description
|
|
|
|
|
The layer adds ReStructuredText (ReST) support to Spacemacs and adds some
|
|
|
|
|
functions to =rst-mode=.
|
|
|
|
|
|
2017-02-02 19:55:18 +00:00
|
|
|
Note: to add =Sphinx= specific support use the layer =sphinx=.
|
|
|
|
|
|
2017-08-28 21:58:10 +00:00
|
|
|
** Features:
|
2017-02-02 14:29:45 +00:00
|
|
|
- =rst= files are supported via Emacs built-in =rst.el=.
|
2016-11-21 23:32:00 +00:00
|
|
|
- Lists are inserted by new functions.
|
2017-02-02 14:29:45 +00:00
|
|
|
- Directives can be inserted easily.
|
2017-02-02 20:01:07 +00:00
|
|
|
- auto-completion for directives and options via =auto-complete-rst=.
|
|
|
|
|
- snippet support via =yasnippet=.
|
2017-02-02 14:29:45 +00:00
|
|
|
|
|
|
|
|
* Install
|
|
|
|
|
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
|
|
|
|
|
add =restructuredtext= to the existing =dotspacemacs-configuration-layers= list
|
|
|
|
|
in this file.
|
|
|
|
|
|
2017-02-02 20:01:07 +00:00
|
|
|
* Configuration
|
|
|
|
|
** Auto-complete
|
|
|
|
|
For now =auto-complete-rst= only works with sphinx 1.4.9 and lower.
|
|
|
|
|
New 1.5 release (as from December 2016) is not yet supported.
|
