summaryrefslogtreecommitdiff
path: root/docs/src/styles.txt
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-01-25 18:58:20 +0100
committerGeorg Brandl <georg@python.org>2007-01-25 18:58:20 +0100
commitd2d1ec5a46a69a7419e03ac65492be4a61d3ce6c (patch)
tree17ff427079feeb4608f24895a8cd2a3697b82819 /docs/src/styles.txt
parent25aa1c390dce75c8721e65c9e56cd085d437a20c (diff)
downloadpygments-git-d2d1ec5a46a69a7419e03ac65492be4a61d3ce6c.tar.gz
[svn] Allow dropping style files into the styles subpackage.
Diffstat (limited to 'docs/src/styles.txt')
-rw-r--r--docs/src/styles.txt12
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/src/styles.txt b/docs/src/styles.txt
index f37b0b7c..d6ba8bd0 100644
--- a/docs/src/styles.txt
+++ b/docs/src/styles.txt
@@ -66,11 +66,21 @@ they can be used for a variety of formatters.)
`default_style` is the style inherited by all token types.
+To make the style usable for Pygments, you must
+
+* either register it as a plugin (see `the plugin docs <plugins.txt>`)
+* or drop it into the `styles` subpackage of your Pygments distribution one style
+ class per style, where the file name is the style name and the class name is
+ `StylenameClass`. For example, if your style should be called
+ ``"mondrian"``, name the class `MondrianStyle`, put it into the file
+ ``mondrian.py`` and this file into the ``pygments.styles`` subpackage
+ directory.
+
Style Rules
===========
-Here a small overview over all allowed styles:
+Here a small overview of all allowed styles:
``bold``
render text as bold