TakeV/spacemacs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+tools/sphinx/README.org
Maximilian Wolff 4110b9d634
[sphinx] Fix typo in documentation
2020-02-22 00:47:37 +01:00

2 KiB
Raw Blame History

Sphinx layer

/TakeV/spacemacs/media/commit/4110b9d634173711032d9467aaa527876342edb6/layers/+tools/sphinx/img/sphinx.png

Description

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

Features:

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

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.

Configuration

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.

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

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

  (sphinx :variables
          rst-sphinx-target-parent "/your/path/of/build/"
          rst-sphinx-target-projects
          '(("project1" . (latex "folder/in/target/parent" t))
            ("project2" . (html  "folder/in/target/parent" nil))))

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.

  (sphinx :variables
          rst-slides-program "chromium")

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