sandbox/latex_directive/README.txt

   1 ==============
   2  Latex README
   3 ==============
   4
   5 .. role:: m(latex)
   6
   7 Overview
   8 ========
   9
  10 The idea is to convert latex fragments into *png* for display in html
  11 model.
  12
  13 Role and directive
  14 ==================
  15
  16 There is a role called ``latex`` that can be used for inline
  17 latex expressions: ``:latex:`$\psi(r) = \exp(-2r)$``` will
  18 produce :m:`$\psi(r)=\exp(-2r)$`.  Inside the back-tics you can write
  19 anything you would write in a LaTeX ducument.
  20
  21 For producing displayed math (like an ``equation*`` environment in a
  22 LaTeX document) there is a ``latex`` role.  If you write::
  23
  24   .. latex-math::
  25
  26      $\psi(r) = e^{-2r}$
  27
  28 you will get:
  29
  30 .. latex::
  31
  32    $\psi(r) = e^{-2r}$
  33
  34
  35
  36 Example
  37 =======
  38
  39 Role
  40 ----
  41
  42 You can use roles for inline stuff:  :latex:`$e=mc^2$`.  Lots of fun.
  43
  44 Or how about: :m:`$x = (-b \pm \sqrt{b^2 - 4ac}) / 2a$`
  45
  46 Directive
  47 ---------
  48
  49
  50
  51 .. latex::
  52
  53    $$-1 = e^{i\pi}$$
  54
  55 More info
  56 =========
  57
  58 No more info at this time.
  59
  60