1. Akihiro Uchida
  2. docutils-dollarmathext

Commits

Akihiro Uchida  committed 811b139

modify README

  • Participants
  • Parent commits 75bd10d
  • Branches default

Comments (0)

Files changed (1)

File README.txt

View file
-==============
- Latex README
-==============
-
-.. role:: m(latex)
+===============================
+ docutils math extension README
+===============================
 
 Overview
 ========
 Role and directive
 ==================
 
-There is a role called ``latex`` that can be used for inline
-latex expressions: ``:latex:`$\psi(r) = \exp(-2r)$``` will
-produce :m:`$\psi(r)=\exp(-2r)$`.  Inside the back-tics you can write
+There is a role called ``math`` that can be used for inline
+latex expressions: ``:math:`\psi(r) = \exp(-2r)``` will
+produce :math:`\psi(r)=\exp(-2r)`.  Inside the back-tics you can write
 anything you would write in a LaTeX ducument.
 
 For producing displayed math (like an ``equation*`` environment in a
-LaTeX document) there is a ``latex`` role.  If you write::
+LaTeX document) there is a ``math`` role.  If you write::
 
-  .. latex-math::
+  .. math::
 
-     $\psi(r) = e^{-2r}$
+     \psi(r) = e^{-2r}
 
 you will get:
 
-.. latex::
+.. math::
 
-   $\psi(r) = e^{-2r}$
+   \psi(r) = e^{-2r}
 
 
 
 Role
 ----
 
-You can use roles for inline stuff:  :latex:`$e=mc^2$`.  Lots of fun.
+You can use roles for inline stuff:  :math:`e=mc^2`.  Lots of fun.
 
-Or how about: :m:`$x = (-b \pm \sqrt{b^2 - 4ac}) / 2a$`
+Or how about: :math:`x = (-b \pm \sqrt{b^2 - 4ac}) / 2a`
 
 Directive
 ---------
 
+.. math::
 
+   -1 = e^{i\pi}
+   
+Dollar math extension
+=====================
 
-.. latex::
-   
-   $$-1 = e^{i\pi}$$
-   
+Additionally, you can use ``$math$`` expression like ``$\pi$`` instead of ``:math:`pi```,
+if you use rst2html with ``--use-dollar-math`` or edit docutils.conf::
+
+  [standalone reader with dollarmath]
+  use_dollar_math: yes
+
+$math$
+
 More info
 =========