https://github.com/Fuco1/sphinx-mode

Minor mode providing sphinx support.
https://github.com/Fuco1/sphinx-mode

Last synced: 8 months ago
JSON representation

Minor mode providing sphinx support.

• Host: GitHub
• URL: https://github.com/Fuco1/sphinx-mode
• Owner: Fuco1
• Created: 2016-09-11T12:27:32.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-05-11T20:23:45.000Z (10 months ago)
• Last Synced: 2025-05-11T21:24:52.878Z (10 months ago)
• Language: Emacs Lisp
• Size: 74.2 KB
• Stars: 19
• Watchers: 4
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 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

* [x] Add fontification support

* [ ] Add support for insertion of labels

* [x] Add support for insertion of references (`:ref:`) (with a menu of available labels)

* [x] 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`.

![fontification](docs/_images/native-fontification.png)

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