Commit 4eea3099 authored by Christoph Ruegge's avatar Christoph Ruegge
Browse files

Basic website setup

parent b0bd0976
......@@ -116,7 +116,7 @@ modindex_common_prefix = ['proxtoolbox.']
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'sphinxdoc'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
......
......@@ -11,10 +11,20 @@ Welcome to ProxToolbox's documentation!
.. include:: ../README.md
.. automodule:: proxtoolbox
Matlab version
--------------
`Download <http://num.math.uni-goettingen.de/~r.luke/proxtoolbox-matlab.tar.gz>`__
Python version
--------------
`Download <http://num.math.uni-goettingen.de/~r.luke/proxtoolbox-python.tar.gz>`__
.. automodule:: proxtoolbox
In the following, we provide a tutorial, a manual and advanced descriptions for the ProxToolbox.
In the following, we provide a tutorial, a manual and advanced descriptions for
the ProxToolbox.
.. toctree::
......
#!/bin/bash
cd "$(dirname $0)"
if ! make html; then
echo "A sphinx error occured. Not uploading website."
exit 1
fi
echo "Uploading website."
rsync -av _build/html/ rluke1@web.num.math.uni-goettingen.de:public_html/proxtoolbox
......@@ -11,8 +11,8 @@ def procrustes(X, Y, scaling=True, reflection='best'):
d, Z, [tform] = procrustes(X, Y)
Inputs:
------------
Parameters
----------
X, Y
matrices of target and input coordinates. they must have equal
numbers of points (rows), but Y may have fewer dimensions
......@@ -28,8 +28,8 @@ def procrustes(X, Y, scaling=True, reflection='best'):
best. setting reflection to True or False forces a solution with
reflection or no reflection respectively.
Outputs
------------
Returns
-------
d
the residual sum of squared errors, normalized according to a
measure of the scale of X, ((X - X.mean(0))**2).sum()
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment