Table of Contents

Sphinx layer

Table of ContentsClose

sphinx.png

1 Description

The layer adds support for the documentation generation system Sphinx to the restructuredtext layer.

1.1 Features:

  • Support for Sphinx project compilation
  • Support for opening Sphinx project target
  • Support for opening Sphinx config file

2 Install

To use this configuration layer, add it to your ~/.spacemacs. You will need to add sphinx to the existing dotspacemacs-configuration-layers list in this file.

3 Configuration

3.1 Sphinx target

To use the layer's Sphinx feature, the following variables should be set.

A parent directory is needed for all Sphinx projects' builds.

(setq rst-sphinx-target-parent "/your/path/of/build/")

Set a directory in the parent directory for each Sphinx project.

(setq rst-sphinx-target-projects
      '(("project1" . (latex "folder/in/target/parent" t))
        ("project2" . (html  "folder/in/target/parent" nil))
        ))

3.2 Web browser

Set the browser for viewing the HTML page of current rst file. This one is optional. If not set, the default browser will be used.

(setq rst-slides-program "chromium")

4 Key bindings

Key binding Description
<SPC> m c c compile projects
<SPC> m c C clean projects
<SPC> m c r rebuild projects
<SPC> m g c open conf.py of current project
<SPC> m o open compiled HTML page of current page

Author: root

Created: 2019-11-10 Sun 14:17

Validate