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
History
syl20bnr 41e546f040 Move all use-package hook declaration to pre-init functions 
Had to create dummy init functions at some places since the owner of a package
is the last layer that defines the init function of a package. And a package
can be installed only if it has an owner.
2018-01-10 23:57:18 -05:00
..
img sphinx: add sphinx logo to README 2017-02-02 15:34:44 -05:00
local/rst-sphinx sphinx: add new conventional command under , c and add , g c 2017-02-03 11:40:19 -05:00
layers.el Happy New Year 2018! 2018-01-04 02:00:25 -05:00
packages.el Move all use-package hook declaration to pre-init functions 2018-01-10 23:57:18 -05:00
README.org Fix documentation for sphinx, confluence, helm and ivy layer 2017-12-16 14:20:41 +02:00

README.org

Sphinx layer

/TakeV/spacemacs/media/commit/04910be2e2eeb1cb6f2ea389df34a1a73f7b8ab6/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.

    (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))
            ))

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")

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