.. SymTensordocumentation master file.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to SymTensor documentation!
======================================

Please refer to https://github.com/yangcal/symtensor for an overview and basic usage guide.
This documentation provides specification of all interface and internal SymTensor functions and classes.
The main interface to SymTensor is the symtensor.tensor object, as well as auxiliary functions in symtensor.aux.
Both are imported automatically when symtensor is imported.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules.rst


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`