Skip to content

Commit ddb6568

Browse files
committed
Add README
1 parent a0c4b11 commit ddb6568

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
A [Pygments](https://pygments.org/) plugin for IPython code & console sessions
2+
3+
[IPython](https://ipython.org/) is an interactive Python shell. Among other features,
4+
it adds some special convenience syntax, including `%magics`, `!shell commands`
5+
and `help?`. This package contains lexers for these, to use with the Pygments syntax
6+
highlighting package.
7+
8+
- The `ipython` lexer should be used where only input code is highlighted
9+
- The `ipythonconsole` lexer works for an IPython session, including code,
10+
prompts, output and tracebacks.
11+
12+
These lexers were previously part of IPython itself (in `IPython.lib.lexers`),
13+
but have now been moved to a separate package.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ name = "pygments_lexers_ipython"
77
authors = [
88
{name = "The IPython Development Team", email = "[email protected]"},
99
]
10-
#readme
10+
readme = "README.md"
1111
classifiers = [
1212
"Framework :: IPython",
1313
"License :: OSI Approved :: BSD License",

0 commit comments

Comments
 (0)