Mercurial > jouvence
changeset 33:7c39da93a0ce
docs: Add logo, do a few text changes.
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Mon, 16 Jan 2017 21:49:48 -0800 |
| parents | 86eaab47f03b |
| children | 093bf35461ba |
| files | docs/_static/jouvence.jpg docs/_static/jouvence_logo.jpg docs/conf.py docs/index.rst docs/raw/fontaine.jpg docs/raw/fontaine.psd docs/raw/fontaine_logo.jpg docs/raw/fontaine_logo.psd docs/raw/jouvence.psd docs/raw/jouvence_logo.psd |
| diffstat | 10 files changed, 10 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/conf.py Mon Jan 16 09:33:00 2017 -0800 +++ b/docs/conf.py Mon Jan 16 21:49:48 2017 -0800 @@ -98,6 +98,8 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +html_logo = '_static/jouvence_logo.jpg' + # -- Options for HTMLHelp output ------------------------------------------
--- a/docs/index.rst Mon Jan 16 09:33:00 2017 -0800 +++ b/docs/index.rst Mon Jan 16 21:49:48 2017 -0800 @@ -1,11 +1,7 @@ -######## -JOUVENCE -######## +.. image:: _static/jouvence.jpg - -`Fountain`_ is a plain text markup language for screenwriting. Jouvence -is a Python package for parsing and rendering Fountain documents. +Jouvence is a Python package for parsing and rendering `Fountain`_ documents. Jouvence supports: @@ -15,8 +11,11 @@ .. _fountain: http://fountain.io/ +Quickstart +========== + Installation -============ +------------ As with many Python packages, it's recommended that you use `virtualenv`_, but since Jouvence doesn't have many dependencies, you should be fine. @@ -37,7 +36,7 @@ Usage -===== +----- The Jouvence API goes pretty much like this:: @@ -53,7 +52,7 @@ Limitations -=========== +----------- Jouvence doesn't support the complete Fountain syntax yet. The following things are not implemented: