Merge start page and theory page, switch to rtd theme

* Switch to rtd theme

* Include general statement and fix settings

* Chnage heading of contents

* Fix intro text

Author: hagenw

Makefile

@@ -16,7 +16,6 @@ SPHINXBUILD   = sphinx-build
 PAPER         =
 SOURCEDIR     = .
 BUILDDIR      = ./_build
-VERSION       = $(shell python ./_include/version.py)
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -45,27 +44,27 @@ clean:
 	rm -rf $(BUILDDIR)/*
 
 html-preview:
-	$(SPHINXBUILD) -b html -A web=0 $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html-preview/$(VERSION)
+	$(SPHINXBUILD) -b html -A web=0 $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html-preview
 	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html-preview/$(VERSION)."
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html-preview/."
 
 html:
-	$(SPHINXBUILD) -b dirhtml -A web=1 $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html/$(VERSION)
+	$(SPHINXBUILD) -b dirhtml -A web=1 $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
 	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(VERSION)."
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/."
 
 latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/latex/$(VERSION)
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/latex
 	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/$(VERSION)."
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex/."
 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
 	      "(use \`make latexpdf' here to do that automatically)."
 
 latexpdf:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/latex/$(VERSION)
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/latex
 	@echo "Running LaTeX files through pdflatex..."
-	$(MAKE) -C $(BUILDDIR)/latex/$(VERSION) all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/$(VERSION)."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex/."
 
 linkcheck:
 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/linkcheck

conf.py

@@ -4,7 +4,6 @@
 import os
 import shlex
 import sphinx_rtd_theme
-import sfsdoc
 #import subprocess
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -37,7 +36,7 @@
 # Enable numbering of figures and tables
 numfig = True
 
-# Plot settings ofr matplot
+# Plot settings for matplot
 plot_include_source = True
 plot_html_show_source_link = False
 plot_html_show_formats = False
@@ -55,7 +54,7 @@
 master_doc = 'contents'
 
 # General information about the project. (substitutions)
-project = 'SFS Toolbox - Documentation'
+project = 'SFS Toolbox -- Theory'
 copyright = '2016, SFS Toolbox Developers'
 author = 'SFS Toolbox Developers'
 
@@ -67,12 +66,6 @@
 except Exception:
     release = '<unknown>'
 
-# Definition of variables that are used by the versions.html theme file
-html_context = {'active_tab': 'theory',
-                'home_url': 'http://theory.sfstoolbox.org',
-                'github_url': 'http://github.com/sfstoolbox/sfs-documentation'}
-
-
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build']
@@ -92,10 +85,10 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "sfs"
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [sfsdoc.get_theme_dir(),sphinx_rtd_theme.get_html_theme_path()]
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -156,7 +149,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  (master_doc, 'sfs-toolbox-documentation.tex', u'SFS Toolbox - Documentation',
+  (master_doc, 'sfs-toolbox-documentation.tex', u'SFS Toolbox -- Theory',
    u'SFS Toolbox team', 'manual'),
 ]
 

contents.txt

@@ -1,10 +1,9 @@
 .. _contents:
 
-=========================
-SFS Toolbox documentation
-=========================
+Contents
+========
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 3
 
     index

index.txt

@@ -1,7 +1,31 @@
-.. _chap-theory:
+SFS Toolbox -- Theory
+=====================
+
+.. .. image:: img/header.png
+
+Sound field synthesis (SFS) includes all methods that try to generate a defined
+sound field in an extended area that is surrounded by loudspeakers. The SFS
+Toolbox focuses on those methods that provide analytical solutions to the
+underlying mathematical problem, namely |WFS|, |NFC-HOA|, and the |SDM|.
+
+The Toolbox provides you with the implementation of the underlying
+mathematics. You can make numerical simulations of the resulting sound fields
+and can even create binaural simulations of the same sound fields. This enables
+you to listen to large loudspeaker arrays, even if you don’t have one in your
+laboratory or at home. In addition, you can easily plug-in your own algorithms
+in order to test or compare them.
+
+The Toolbox is structured in the following three projects.
+
+Theory:
+    http://sfstoolbox.org/ (current page)
+
+SFS Toolbox for Matlab/Octave:
+    http://matlab.sfstoolbox.org
+
+SFS Toolbox for Python:
+    http://python.sfstoolbox.org
 
-Theory of sound field synthesis
-===============================
 
 .. Latex macros definitions used in this document
 .. container:: hidden
@@ -17,10 +41,10 @@ Theory of sound field synthesis
         \def \twohalfD {{2.5\text{D}}\,}
         \def \threeD {{3\text{D}}\,}
 
-Most of the figures in this chapter are directly created by the python variant
-of the |SFS Toolbox|. All of them display the corresponding code for creating
-them directly before the actual figure. In order to recreate them, you have to
-execute the following code first:
+Most of the figures in this page are directly created by the SFS Toolbox for
+Python. All of them display the corresponding code for creating them directly
+before the actual figure. In order to recreate them, you have to execute the
+following code first:
 
 .. Common plotting settings
 .. plot::
@@ -476,7 +500,7 @@ into :eq:`D_wfs` as
         \underbrace{-2 w(\x_0) \partial_\n S(\x_0,\omega)}_{D(\x_0,\omega)} \;
         {\mathop{\mathrm{d}{A}}}(\x_0).
 
-In the |SFS Toolbox| we assume convex secondary source distributions, which
+In the SFS Toolbox we assume convex secondary source distributions, which
 allows to formulate the window function by a scalar product with the normal
 vector of the secondary source distribution.  In general, also non-convex
 secondary source distributions can be used with |WFS| – compare the appendix in
@@ -635,7 +659,7 @@ This document will consider only model-based rendering.
 
 Frequently applied models in model-based rendering are plane waves, point
 sources, or sources with a prescribed complex directivity. In the following the
-models used within the |SFS Toolbox| are presented.
+models used within the SFS Toolbox are presented.
 
 .. _sec-plane-wave:
 
@@ -1156,7 +1180,7 @@ they can easily be omitted. For corresponding driving functions for focused
 sources without the evanescent part of the sound field see [SporsAhrens2010]_
 for |SDM| and [AhrensSpors2009b]_ for |NFC-HOA|.
 
-In the |SFS Toolbox| only focused sources in |WFS| are considered at the moment.
+In the SFS Toolbox only focused sources in |WFS| are considered at the moment.
 
 
 .. _sec-driving-functions-wfs:
@@ -1337,7 +1361,7 @@ which is the traditional formulation of a point source in |WFS| as given by eq.
 (2.22a) in [Verheijen1997]_ [#F6]_ for the 2.5D. It has the advantage that its
 temporal domain version could again be implemented as a simple weighting- and
 delaying-mechanism. This is the default driving function for a point source in
-the |SFS Toolbox|.
+the SFS Toolbox.
 
 Transfered to the temporal domain via an inverse Fourier transform :eq:`ifft` it
 follows
@@ -1529,7 +1553,7 @@ or by using an approximated point source as
         {\mathrm{e}}^{{\mathrm{i}}\frac{\omega}{c}|\x_0-\xs|}.
 
 As before for other source types, the approximated versions are the default
-driving functions for a focused source used in the |SFS Toolbox|.
+driving functions for a focused source used in the SFS Toolbox|.
 
 Transfered to the temporal domain via an inverse Fourier transform :eq:`ifft` it
 follows

requirements.txt

@@ -1,5 +1,3 @@
--e git+https://github.com/sfstoolbox/sfs-documentation-theme.git#egg=SfsDoc
-
 jinja2
 pygments
 sphinx