docs/source/index.rst
.. LiberTEM documentation master file, created by
sphinx-quickstart on Wed May 2 15:54:09 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
LiberTEM - Open Pixelated STEM platform
=======================================
.. include:: ../../README.rst
.. see also: https://muffinresearch.co.uk/selectively-including-parts-readme-rst-in-your-docs/
.. later, maybe :start-after: inclusion-marker-do-not-remove
Documentation
=============
.. toctree::
:maxdepth: 2
:caption: User manual
install
usage
applications
formats
sample_datasets
api
udf
dask
changelog
citing
acknowledgments
.. toctree::
:maxdepth: 2
:caption: Reference
reference/index
tips
packages
concepts
performance
why_python
.. toctree::
:maxdepth: 2
:caption: For developers
dev/setup.rst
contributing
debugging
architecture
dev/how-io-works
dev/executors
authorship
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Citations
---------
.. bibliography:: references-libertem.bib