Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kostafey/sphinx-frontend
Launch build process for rst documents via sphinx.
https://github.com/kostafey/sphinx-frontend
Last synced: 3 months ago
JSON representation
Launch build process for rst documents via sphinx.
- Host: GitHub
- URL: https://github.com/kostafey/sphinx-frontend
- Owner: kostafey
- Created: 2013-12-23T09:53:02.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-10-25T07:58:53.000Z (about 8 years ago)
- Last Synced: 2024-04-26T02:31:28.936Z (7 months ago)
- Language: Emacs Lisp
- Homepage:
- Size: 4.88 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sphinx-frontend
sphinx-frontend provides a simple way to find closest
[Sphinx](http://sphinx-doc.org/) configuration file (`conf.py`) and run the
Sphinx.
## Installation
Add MELPA (if not yet) to your `package-archives` list:
```lisp
(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:
```lisp
(require 'sphinx-frontend)
```
## Usage
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
## License
Copyright © 2012-2016 kostafey
Distributed under the General Public License 2.0+