Simple math — math & cmath

Syntax of math expression has been borrowed from TeX; at the moment just subscripts and superscripts are supported. Small letters are italized, and some replacements are made.

Both roles math and cmath do the same thing, just produce nodes with different class names. For example my cmath style definition: display: block; text-align: center; font-size: larger.

Syntax:

:math:`expression`
:cmath:`expression`

Famous Einstein equation (e = m*c^2)

e = m ⋅ c²

Determinant of matrix A_4x4 (a_{11}*a_{22} - a_{12}*a_{21}):

det(A_4x4) = a₁₁ ⋅ a₂₂ − a₁₂ ⋅ a₂₁

Cubic Bezier curve (p(t) = p_0 B^3_0(t) + p_1 B^3_1(t) + p_2 B^3_2(t) + p_3 B^3_3(t), 1 >= t >= 0):

p(t) = p₀B³₀(t) + p₁B³₁(t) + p₂B³₂(t) + p₃B³₃(t), 1 ≥ t ≥ 0

Polynomial of degree n (f(x) = a_0*x^n + a_1*x^{n-1} + ... + a_n*x^0):

f(x) = a₀ ⋅ xⁿ + a₁ ⋅ x^{n − 1} + … + a_n ⋅ x⁰

Trigonometry: sin^2x+cos^2x=1

sin²x + cos²x = 1

Wikipedia links

Links to Wikipedia articles. For example :enwiki:`Albert Einstein` produces Albert Einstein, and :enwiki:`Albert Einstein|Einstein` makes shorter link title Einstein

Python code snippets insertion

This directive allows to input selected functions or classes from Python source file.

Syntax

.. pycode:: path&filename
        :def:    function_or_class_name
        :lineno:
        :unindent:
        :tabstop:       number

Line numbering is enabled if field lineno is present.

If field unindent is present then block's indention is set to 0; otherwise pycode keeps original source indention.

If field tabstop is set, then tabs are expanded with given tab stop.

Field def is a string of space separated code's block pointers, i.e. string "def" or "class" then colon then name of function or class.

Examples

Get top-level function:

.. pycode:: pycode.py
   :def:    def:py_getdef

Result:

def py_getdef(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine):

	filename = arguments[0]
	numbers  = 'lineno' 	in options
	unindent = 'unindent'	in options
	pattern  = options['def']
	try:
		tabstop = options['tabstop']
	except KeyError:
		tabstop = None

	# get source direcorty
	source     = state_machine.input_lines.source(lineno - state_machine.input_offset - 1)
	source_dir = os.path.dirname(os.path.abspath(source))

	f = open(os.path.join(source_dir, filename), 'r')
	if tabstop is None:
		lines = [(lineno+1, line.rstrip())\
		         for (lineno, line) in enumerate(f)]
	else:
		lines = [(lineno+1, line.rstrip().expandtabs(tabstop))\
		         for (lineno, line) in enumerate(f)]

	f.close()

	for block in pattern.replace('\t',' ').split(' '):
		kind, name = block.split(':')
		lines = py_grep(lines, name.strip(), kind.strip())

	if not lines:	# empty
		return [nodes.literal_block(”, ”)]
	else:
		if unindent:
			# get first line indention
			n = len(lines[0][1]) - len(lines[0][1].lstrip())
			for i, (lineno, line) in enumerate(lines):
				lines[i] = (lineno, line[n:])

		if numbers:
			text = '\n'.join("%4d %s" % item for item in lines)
		else:
			text = '\n'.join( (line for (lineno,line) in lines) )

		return [nodes.literal_block(text, text)]

Get local function defined inside py_getblock:

.. pycode:: pycode.py
   :def:    def:py_getblock def:get_indention
   :lineno:

Result:

  86 	def get_indention(line, expandtabs=True):
  87 		"""Get line's indention"""
  88 		l = len(line)
  89 		if expandtabs:
  90 			t = len(line.expandtabs().lstrip())
  91 			return l-t
  92 		else:
  93 			t = len(line.lstrip())
  94 			return l-t