Mercurial > jouvence

comparison docs/index.rst @ 33:7c39da93a0ce

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Add logo, do a few text changes.
author Ludovic Chabant <ludovic@chabant.com>
date Mon, 16 Jan 2017 21:49:48 -0800
parents 9ae14e9615e6
children 093bf35461ba
comparison
equal deleted inserted replaced
32:86eaab47f03b 33:7c39da93a0ce
1 1
2 ######## 2 .. image:: _static/jouvence.jpg
3 JOUVENCE
4 ########
5 3
6 4 Jouvence is a Python package for parsing and rendering `Fountain`_ documents.
7 `Fountain`_ is a plain text markup language for screenwriting. Jouvence
8 is a Python package for parsing and rendering Fountain documents.
9 5
10 Jouvence supports: 6 Jouvence supports:
11 7
12 * Most of the Fountain specification (see limitations below). 8 * Most of the Fountain specification (see limitations below).
13 * Rendering to HTML and terminals. 9 * Rendering to HTML and terminals.
14 10
15 .. _fountain: http://fountain.io/ 11 .. _fountain: http://fountain.io/
16 12
17 13
14 Quickstart
15 ==========
16
18 Installation 17 Installation
19 ============ 18 ------------
20 19
21 As with many Python packages, it's recommended that you use `virtualenv`_, 20 As with many Python packages, it's recommended that you use `virtualenv`_,
22 but since Jouvence doesn't have many dependencies, you should be fine. 21 but since Jouvence doesn't have many dependencies, you should be fine.
23 22
24 You can install Jouvence the usual way:: 23 You can install Jouvence the usual way::
35 34
36 .. _virtualenv: https://virtualenv.pypa.io/en/stable/ 35 .. _virtualenv: https://virtualenv.pypa.io/en/stable/
37 36
38 37
39 Usage 38 Usage
40 ===== 39 -----
41 40
42 The Jouvence API goes pretty much like this:: 41 The Jouvence API goes pretty much like this::
43 42
44 from jouvence.parser import JouvenceParser 43 from jouvence.parser import JouvenceParser
45 from jouvence.html import HtmlDocumentRenderer 44 from jouvence.html import HtmlDocumentRenderer
51 renderer.render_doc(document, fp) 50 renderer.render_doc(document, fp)
52 51
53 52
54 53
55 Limitations 54 Limitations
56 =========== 55 -----------
57 56
58 Jouvence doesn't support the complete Fountain syntax yet. The following things 57 Jouvence doesn't support the complete Fountain syntax yet. The following things
59 are not implemented: 58 are not implemented:
60 59
61 * Dual dialogue 60 * Dual dialogue