summaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorThomas Aglassinger <roskakori@users.sourceforge.net>2013-04-01 16:50:09 +0200
committerThomas Aglassinger <roskakori@users.sourceforge.net>2013-04-01 16:50:09 +0200
commitf943519622bb8b47e01d467bed181acc39b64c34 (patch)
tree69bb0c528c32655d82b766c93a32e7ad045ff7f8 /docs/src
parente58e0a6510a0458fb54898f77665b7de2a29507d (diff)
downloadpygments-f943519622bb8b47e01d467bed181acc39b64c34.tar.gz
* Fixed broken sourcode directives.
* Cleaned up typos and wording.
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/lexerdevelopment.txt18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/src/lexerdevelopment.txt b/docs/src/lexerdevelopment.txt
index 9d3509a0..9a227c2b 100644
--- a/docs/src/lexerdevelopment.txt
+++ b/docs/src/lexerdevelopment.txt
@@ -83,20 +83,20 @@ If no rule matches at the current position, the current char is emitted as an
1.
-Adding and testing your lexer
-=============================
+Adding and testing a new lexer
+==============================
To make pygments aware of your new lexer, you have to perform the following
steps:
First, change to the current directory containing the pygments source code:
-.. sourcecode::
+.. sourcecode:: console
$ cd .../pygments-main
Next, make sure the lexer is known from outside of the module. All modules in
-the ``pygments.lexers`` specify ``__all__``. For example, ``other.py``sets:
+the ``pygments.lexers`` specify ``__all__``. For example, ``other.py`` sets:
.. sourcecode:: python
@@ -105,10 +105,10 @@ the ``pygments.lexers`` specify ``__all__``. For example, ``other.py``sets:
Simply add the name of you lexer class to this list.
Now update the ``python.lexers._mapping``. This is a generated module which
-can update itself changing the current directory to its location and simply
+can update itself by changing the current directory to its location and
running it:
-.. sourcecode::
+.. sourcecode:: console
$ cd pygments/lexers/
$ python _mapping.py
@@ -116,7 +116,7 @@ running it:
Without the ``cd`` command, you will get an ``ImportError``:
-.. sourcecode::
+.. sourcecode:: pycon
ImportError: No module named ez_setup
@@ -126,7 +126,7 @@ To test the new lexer, store an example file with the proper extension in
Now you can use pygmentize to render your example to HTML:
-.. sourcecode::
+.. sourcecode:: console
$ ./pygmentize -O full -f html -o /tmp/example.html tests/examplefiles/example.diff
@@ -139,7 +139,7 @@ To view the result, open ``/tmp/example.html`` in your browser.
Once the example renders as expected, you should run the complete test suite:
-.. sourcecode::
+.. sourcecode:: console
$ python tests/run.py