[Catalog-sig] Syntax highlighting for code examples on PyPI

[Michael Foord]

On 18 October 2010 13:33, Éric Araujo <merwok at netwok.org> wrote:

> > A few lines of code in PyPI hooking up Pygments into reStructured Text
> > (Pygments provides a ready made directive for this purpose) and including
> > the pygments css in PyPI pages would allow this.
>
> FTR, there are two ways to integrate reST and Sphinx: The sourcecode
> pure-reST directive provided by Pygments and the code-block directive
> available in Sphinx.  For long_description values built from external
> files that are also part of a Sphinx-made documentation, code-block can
> be used but not sourcecode.
>
> Of course, Georg knows that, being the author of both, and his plan to
> use heuristics and not force any directive sounds good.  On the other
> hand, the directives allow one to specify the language, which can be
> useful for config file examples on PyPI pages.
>


Also for C code examples which some PyPI packages use. I don't think "sphinx
style" *precludes* specifying the language though?

Michael


>
> Regards
>
>


-- 
http://www.voidspace.org.uk
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/catalog-sig/attachments/20101018/3517c639/attachment.html>