Skip to content
Snippets Groups Projects
Commit 9b69ec9b authored by Philipp Arras's avatar Philipp Arras
Browse files

Docs

parent c3d60a3e
Branches
Tags
No related merge requests found
Pipeline #105939 passed
Contributing to resolve
=======================
Build the documentation
-----------------------
To build the documentation from source, install `sphinx
<https://www.sphinx-doc.org/en/stable/index.html>`_ and the `pydata sphinx theme
<https://github.com/pydata/pydata-sphinx-theme>`_ on your system and run
.. code-block:: sh
sh docs/generate.sh
Resolve Resolve Manual
======= ==============
Resolve is a Bayesian radio imaging algorithm. Welcome to the resolve documentation!
References
----------
FIXME
Contents
........
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
Package Documentation <mod/resolve> User Guide <user/index>
API reference <mod/resolve>
Development <dev/index>
Resolve user guide
==================
This guide is an overview and explains the main idea behind resolve. More details
are found in the `API reference <../mod/resolve.html>`_.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment