fuco1 / sphinx-mode

Minor mode providing sphinx support.

sphinx-mode

Minor mode providing sphinx support.

Usage

In your rst-mode buffer call M-x sphinx-mode to add all the extra features.

Features

• Add fontification support
• Add support for insertion of labels
• Add support for insertion of references (:ref:) (with a menu of available labels)
• Add support for jumping to a label/reference
• Add footnote ([#note]) support
• Add reference ([ref]) support

Native code-block fontification

Similar to org-mode, we provide native emacs fontification of code blocks, which can be tweaked by changing sphinx-code-block-face.

Compile and view Sphinx projects

In rst-mode, rst-compile prompts you to run rst2html, but Sphinx projects should be compiled by running make in the project directory.

sphinx-compile (C-c C-x C-c) locates the directory containing the Makefile and runs make $FORMAT, prompting you for a $FORMAT in the minibuffer (default html).

sphinx-compile-and-view (C-c C-x C-v) runs sphinx-compile, then opens with xdg-open the compiled version of the source file being visited by the current buffer.

sphinx-mode's Issues

Add a face for the code-block background

sphinx-mode does not depend on f on melpa

Somehow sphinx-mode does not depend on f on melpa, although appears to be included in the Cask file. However it also includes dash as a dependency, which is also not visible on melpa.

This currently results in an error when sphinx-mode is started.

It is however easy to work around that: just install f and dash manually.

highlight code blocks that don't use the code-block directive

restructuredtext has concise code blocks using ::.

This:

Example:

.. code-block::

  {"oh": "hi"}

is equivalent to:

Example::

  {"oh": "hi"}

Without preceding text, it looks like this:

::

  {"oh": "hi"}

it would be nice if this package would also fontify those blocks. it would need some "default" language (python in sphinx).

Create a Makefile to make releases automatic

Also, Fix version number in the Cask/pkg files (0.1.1)