Reorganize docs and some fixes

docs/source/api.rst

@@ -8,19 +8,27 @@ API Documentation
 :Year: 2020
 :Copyright: GNU Public License v3
 
-.. versionadded:: 1.0.0
-
-This module provides an updated interface for the HOLE_ suite of tools
+This toolkit provides an updated interface for the HOLE_ suite of tools
 :cite:p:`Smart1993,Smart1996` to analyse an ion channel pore or transporter
 pathway :cite:p:`Stelzl2014` as a function of time or arbitrary order
-parameters. It replaces :mod:`mdahole2.analysis.hole`.
+parameters.
 
 HOLE_ must be installed separately and can be obtained in binary form
 from http://www.holeprogram.org/ or as source from
 https://github.com/osmart/hole2. (HOLE is open source and available
 under the Apache v2.0 license.)
 
+.. _HOLE: http://www.holeprogram.org
+
 Module
 ------
 
-.. automodule:: mdahole2.analysis
+.. automodule:: mdahole2.analysis.hole
+   :members:
+
+.. automodule:: mdahole2.analysis.utils
+   :members:
+
+.. automodule:: mdahole2.analysis.templates
+   :members:
+

docs/source/conf.py

@@ -138,7 +138,7 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-html_css_files = ['custom.css']  # , 'readable.css']
+html_css_files = []  # , 'readable.css']
 
 # Custom sidebar templates, maps document names to template names.
 # alabaster sidebars

docs/source/getting_started.rst

@@ -2,7 +2,7 @@ Getting Started
 ===============
 
 This page details how to get started with ``mdahole2``.
-Note that ``mdahole2`` is only supported on Linux or macOS.
+Note that ``mdahole2`` is currently only supported on Linux or macOS.
 
 Documentation
 ~~~~~~~~~~~~~
@@ -45,3 +45,19 @@ From the repository root directory, run
 	conda build . && conda install --use-local mdahole2
 
 to build the package and install the local build.
+
+Installing hole2
+~~~~~~~~~~~~~~~~
+
+``mdahole2`` requires the ``hole2`` executable to be installed.
+
+This is most easily done using ``conda``, ``mamba``, or a similar
+package manager. For example, to install ``hole2`` using ``mamba``:
+
+.. code:: bash
+
+	mamba install -c conda-forge hole2
+
+Alternatively, ``hole2`` can be installed from the original HOLE_ website.
+
+.. _HOLE: http://www.holeprogram.org

docs/source/index.rst

@@ -11,7 +11,9 @@ Welcome to mdahole2's documentation!
    :caption: Contents:
 
    getting_started
+   usage
    api
+   references
 
 Indices and tables
 ==================