ReStructured Text

Resources

• http://sphinx-doc.org/markup/
• http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
• http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html

Examples

Math

• Inline math:

  \\(\\boldsymbol{\\nabla} \\times \\mathbf{e} = -\\frac{\\partial \\mathbf{b}}{\\partial t}\\)
  

• displayed, numbered equations

  .. math:: 
      \boldsymbol{\nabla} \times \mathbf{e} = -\frac{\partial \mathbf{b}}{\partial t}
      :label: faraday_time
  

• To include something from the equation bank

  .. include:: ../equation_bank/ohms_law_freq.rst
  

To reference something from the equation bank by number ``:eq:`ohms_law_freq```. When adding equations to the equation bank, please make sure the label and titles match!

Links and References

Internal pages:

• To reference another page within the site, you do

  :ref:`constitutive_relations_index`
  

  (note that this is at the top of the file constitutive_relations/index.rst)

Bold and italics

• bold: **bold**
• italics: *italicize*

Some Quirks

• spaces matter. Be sure to use "indent using spaces" in your text editor (if using sublime see bottom right of window).
• inline math needs \\ while displayed math needs only \ for characters and tex math
• before and after and of the new environments (ie. ..math::, ..include::, ..figure::, tables, and lists), include a line break