spacemacs/layers/+lang/restructuredtext/README.org

#+TITLE: reStructuredText layer

[[file:img/restructuredtext.png]]

* Table of Contents                                        :TOC_4_gh:noexport:
- [[#description][Description]]
  - [[#features][Features]]
- [[#install][Install]]
- [[#configuration][Configuration]]
  - [[#auto-complete][Auto-complete]]

* Description
The layer adds ReStructuredText (ReST) support to Spacemacs and adds some
functions to =rst-mode=.

Note: to add =Sphinx= specific support use the layer =sphinx=.

** Features
- =rst= files are supported via Emacs built-in =rst.el=.
- Lists are inserted by new functions.
- Directives can be inserted easily.
- auto-completion for directives and options via =auto-complete-rst=.
- snippet support via =yasnippet=.

* 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.

* 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.
Rename ReST layer to restructuredtext and clean up layer rest can be confusing since there is already a restclient layer. 2017-02-02 14:29:45 +00:00			`#+TITLE: reStructuredText layer`

			`[[file:img/restructuredtext.png]]`

			`* Table of Contents :TOC_4_gh:noexport:`
update docs to the new toc-org format 2017-05-22 14:16:12 +00:00			`- [[#description][Description]]`
			`- [[#features][Features]]`
			`- [[#install][Install]]`
			`- [[#configuration][Configuration]]`
			`- [[#auto-complete][Auto-complete]]`
Rename ReST layer to restructuredtext and clean up layer rest can be confusing since there is already a restclient layer. 2017-02-02 14:29:45 +00:00
			`* Description`
			`The layer adds ReStructuredText (ReST) support to Spacemacs and adds some`
			`functions to =rst-mode=.`

reST: Extract sphinx specific config to a stand alone sphinx layer 2017-02-02 19:55:18 +00:00			`Note: to add =Sphinx= specific support use the layer =sphinx=.`

Rename ReST layer to restructuredtext and clean up layer rest can be confusing since there is already a restclient layer. 2017-02-02 14:29:45 +00:00			`** Features`
			`- =rst= files are supported via Emacs built-in =rst.el=.`
Remove trailing whitespace from all files 2016-11-21 23:32:00 +00:00			`- Lists are inserted by new functions.`
Rename ReST layer to restructuredtext and clean up layer rest can be confusing since there is already a restclient layer. 2017-02-02 14:29:45 +00:00			`- Directives can be inserted easily.`
restructuredtext: mention auto-complete-rst to README 2017-02-02 20:01:07 +00:00			`- auto-completion for directives and options via =auto-complete-rst=.`
			`- snippet support via =yasnippet=.`
Rename ReST layer to restructuredtext and clean up layer rest can be confusing since there is already a restclient layer. 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.`

restructuredtext: mention auto-complete-rst to README 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.`