sphinx-contrib / hyphenator /

Filename Size Date modified Message
..
sphinxcontrib
59 B
49 B
1.1 KB
81 B
1.1 KB
868 B
sphinxcontrib.hyphenator
========================

This extension provides hyphenation for html documentation generated
with Sphinx_. It loads the JavaScript package hypenator.js_ to hyphenate
documents on client side.

Because hyphenator.js is quite large, it is not included in the extension.

Configuration Parameters
------------------------

hyphenator_path

   The path to the hyphenator.js file. 

   Default value is http://hyphenator.googlecode.com/svn/trunk/
   that loads the JavaScript from the project repository. If you want
   Hyphenator to be available offline, you have to download it and set this
   value to a different path.

   The path can be absolute or relative; if it is relative, it is relative to
   the _static directory of the built docs.

hyphenator_language

   The hyphenator extension sets the language for hyphenator.js to the config
   value "language". If this does not work you can set hyphenator_language in
   your conf.py
   (see: http://code.google.com/p/hyphenator/wiki/en_AddNewLanguage for
   supported languages).


.. _`Sphinx`: http://sphinx.pocoo.org/latest
.. _`hypenator.js`: http://code.google.com/p/hyphenator/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.