Skip to content

Commit

Permalink
update main documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rutgerfick committed Feb 2, 2018
1 parent 1a085a7 commit 599335f
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,19 @@
.. microstruktur documentation master file, created by sphinx-quickstart on Tue Apr 14 10:29:06 2015. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive.
Welcome to microstruktur's documentation!
Welcome to dmipy's documentation!
====================================

`Microstruktur` is a template for a small scientific Python project.
The dmipy software package facilitates state-of-the-art diffusion MRI Microstructure Imaging using a "Building Block" philosophy. In this philosophy, any combination of biophysical models, typically representing intra- and/or extra-axonal tissue compartments, can be easy combined into a multi-compartment Microstructure Model in just a few lines of code.

To see how to use it, please refer to the `README file
<https://github.com/uwescience/microstruktur/blob/master/README.md>`_ in the Github repository.

This is an example of documentation of the software, using sphinx_.

.. _sphinx: http://sphinx-doc.org/
<https://github.com/AthenaEPI/dmipy/blob/master/README.md>`_ in the Github repository.


Contents:

.. toctree::
:maxdepth: 2

theory
auto_examples/index
reference/index

Expand Down

0 comments on commit 599335f

Please sign in to comment.