development.rst

Development

Build the documentation locally

Build the documentation using:

pip install -e .[docs]  # install docs extra
cd docs/
make html  # build html documentation

After building, find the documentation in docs/build/html/index.html.

Sphinx cheat sheet

• Add code with syntax highlighting like this:

  def f(var):
      return "string"

• Write your mathematical formulae using LaTeX, in line exp ( − i2π) or displayed

  
  $$f(x) = \int_0^\infty \exp\left(\frac{x^2}{2}\right)\,dx$$
  

• You want to refer to a particular function or class? You can!

  lammps_interface.structure_data.MolecularGraph

• Check out the source of any page via the link in the bottom right corner.

reST source of this page:

development.rst