diff options
| author | Stefan van der Walt <stefan@sun.ac.za> | 2008-06-11 18:38:20 +0000 |
|---|---|---|
| committer | Stefan van der Walt <stefan@sun.ac.za> | 2008-06-11 18:38:20 +0000 |
| commit | 327a4d2a4a78c538db5797b05379a3a7c52b2d23 (patch) | |
| tree | 9b5a53508bfb7dc8ad294eebfd26f81d70e025d4 | |
| parent | c0bdc3a648a0106d6fd706661c1a50235b4b924c (diff) | |
| download | numpy-327a4d2a4a78c538db5797b05379a3a7c52b2d23.tar.gz | |
How to use variables in math markup.
| -rw-r--r-- | numpy/doc/HOWTO_DOCUMENT.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/numpy/doc/HOWTO_DOCUMENT.txt b/numpy/doc/HOWTO_DOCUMENT.txt index 55d7d51f4..9cde88d6f 100644 --- a/numpy/doc/HOWTO_DOCUMENT.txt +++ b/numpy/doc/HOWTO_DOCUMENT.txt @@ -237,6 +237,12 @@ The sections of the docstring are: The value of :math:`\omega` is larger than 5. + Variable names are displayed in typewriter font, obtained by using + ``\mathtt{var}``:: + + We square the input parameter `alpha` to obtain + :math:`\mathtt{alpha}^2`. + Note that LaTeX is not particularly easy to read, so use equations sparingly. |