sphinx-frontend provides a simple way to find closest
Sphinx configuration file (conf.py
) and run the
Sphinx.
Add MELPA (if not yet) to your package-archives
list:
(require 'package)
(add-to-list 'package-archives
'("melpa" . "https://melpa.org/packages/"))
(package-initialize)
Then you can install sphinx-frontend
with the following command:
M-x package-install [RET] sphinx-frontend [RET]
Load sphinx-frontend:
(require 'sphinx-frontend)
List of interactive commands (added or replaced in rst-mode-map
):
Key | Command | Description |
---|---|---|
C-c h | sphinx-build-html |
Compile rst files to html via sphinx |
C-c l | sphinx-build-latex |
Compile rst files to latex |
C-c p | sphinx-run-pdflatex |
Ad-hoc call pdflatex for LaTeX-builded documentation |
| `sphinx-clean-html` | Remove `sphinx-output-dir-html` dir
| `sphinx-clean-pdf` | Remove `sphinx-output-dir-pdf` dir
Copyright © 2012-2016 kostafey kostafey@gmail.com
Distributed under the General Public License 2.0+