9e216da9ef
After go1.16, go will use module mode by default, even when the repository is checked out under GOPATH or in a one-off directory. Add go.mod, go.sum to keep this repo buildable without opting out of the module mode. > go mod init github.com/mmcgrana/gobyexample > go mod tidy > go mod vendor In module mode, the 'vendor' directory is special and its contents will be actively maintained by the go command. pygments aren't the dependency the go will know about, so it will delete the contents from vendor directory. Move it to `third_party` directory now. And, vendor the blackfriday package. Note: the tutorial contents are not affected by the change in go1.16 because all the examples in this tutorial ask users to run the go command with the explicit list of files to be compiled (e.g. `go run hello-world.go` or `go build command-line-arguments.go`). When the source list is provided, the go command does not have to compute the build list and whether it's running in GOPATH mode or module mode becomes irrelevant.
83 lines
2.5 KiB
Python
83 lines
2.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
The Pygments reStructuredText directive
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
This fragment is a Docutils_ 0.5 directive that renders source code
|
|
(to HTML only, currently) via Pygments.
|
|
|
|
To use it, adjust the options below and copy the code into a module
|
|
that you import on initialization. The code then automatically
|
|
registers a ``sourcecode`` directive that you can use instead of
|
|
normal code blocks like this::
|
|
|
|
.. sourcecode:: python
|
|
|
|
My code goes here.
|
|
|
|
If you want to have different code styles, e.g. one with line numbers
|
|
and one without, add formatters with their names in the VARIANTS dict
|
|
below. You can invoke them instead of the DEFAULT one by using a
|
|
directive option::
|
|
|
|
.. sourcecode:: python
|
|
:linenos:
|
|
|
|
My code goes here.
|
|
|
|
Look at the `directive documentation`_ to get all the gory details.
|
|
|
|
.. _Docutils: http://docutils.sf.net/
|
|
.. _directive documentation:
|
|
http://docutils.sourceforge.net/docs/howto/rst-directives.html
|
|
|
|
:copyright: Copyright 2006-2015 by the Pygments team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
# Options
|
|
# ~~~~~~~
|
|
|
|
# Set to True if you want inline CSS styles instead of classes
|
|
INLINESTYLES = False
|
|
|
|
from pygments.formatters import HtmlFormatter
|
|
|
|
# The default formatter
|
|
DEFAULT = HtmlFormatter(noclasses=INLINESTYLES)
|
|
|
|
# Add name -> formatter pairs for every variant you want to use
|
|
VARIANTS = {
|
|
# 'linenos': HtmlFormatter(noclasses=INLINESTYLES, linenos=True),
|
|
}
|
|
|
|
|
|
from docutils import nodes
|
|
from docutils.parsers.rst import directives, Directive
|
|
|
|
from pygments import highlight
|
|
from pygments.lexers import get_lexer_by_name, TextLexer
|
|
|
|
class Pygments(Directive):
|
|
""" Source code syntax hightlighting.
|
|
"""
|
|
required_arguments = 1
|
|
optional_arguments = 0
|
|
final_argument_whitespace = True
|
|
option_spec = dict([(key, directives.flag) for key in VARIANTS])
|
|
has_content = True
|
|
|
|
def run(self):
|
|
self.assert_has_content()
|
|
try:
|
|
lexer = get_lexer_by_name(self.arguments[0])
|
|
except ValueError:
|
|
# no lexer found - use the text one instead of an exception
|
|
lexer = TextLexer()
|
|
# take an arbitrary option if more than one is given
|
|
formatter = self.options and VARIANTS[list(self.options)[0]] or DEFAULT
|
|
parsed = highlight(u'\n'.join(self.content), lexer, formatter)
|
|
return [nodes.raw('', parsed, format='html')]
|
|
|
|
directives.register_directive('sourcecode', Pygments)
|