Work on documentation.

doc/Makefile

@@ -87,11 +87,8 @@ latex:
 	      "run these through (pdf)latex."
 
 latexpdf: latex
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
-	@echo "Running LaTeX files through pdflatex..."
 	make -C _build/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in _build/latex."
-
+
 changes:
 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 	@echo

doc/conf.py

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Hermes2D documentation build configuration file, created by
-# sphinx-quickstart on Fri Oct 30 19:23:04 2009.
+# Hermes documentation build configuration file
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -199,20 +198,20 @@
 
 # General information about the project.
 project = u'Hermes'
-copyright = u'2009-2011, hp-FEM group at UNR'
+copyright = u'2009-2013, Faculty of Electrical Engineering, UWB, Czech Republic and University of Nevada in Reno, United States'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = '2.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.0'
+release = '2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+language = c
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -346,7 +345,7 @@
 #html_file_suffix = '.html'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Hermes2Ddoc'
+htmlhelp_basename = 'HermesDoc'
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -360,8 +359,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'Hermes2D.tex', u'Hermes2D Documentation',
-   u'hp-FEM group at UNR', 'manual'),
+  ('index', 'Hermes.tex', u'Hermes Documentation',
+   u'Faculty of Electrical Engineering, UWB, Czech Republic and University of Nevada in Reno, United States', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

doc/index.rst

@@ -14,10 +14,9 @@ with emphasis on nonlinear, time-dependent, multi-physics problems.
 This document is organized as follows: 
 
 * Section 1 provides general information about Hermes and the computational methods it uses,
-  and gives references to underlying scientific articles.
-* Section 2 describes how to install Hermes on various hardware platforms, and how to 
-  install matrix solver packages and various optional packages. 
-* Section 3 is the core documentation section, you will find developers documentation in Doxygen, 
+  and how to install Hermes on various hardware platforms.
+* Section 2 is the Getting Started Guide - to get you started in no time.
+* Section 3 is the extended documentation section, you will find developers documentation in Doxygen, 
   as well as step-by-step user documentation in tutorials and advanced examples. 
 * Section 4 explains how to use Git and Github, and how you can contribute to the project if interested.
 
@@ -33,11 +32,10 @@ Introduction
 
     src/about-hermes
     src/math-background
-    src/web-access
     src/citing-hermes
 
-Installation
-------------
+Section 1 - Installation
+------------------------
 
 .. toctree::
     :maxdepth: 1
@@ -48,38 +46,30 @@ Installation
     src/installation/matrix_solvers
     src/installation/exodusII_netcdf
 
-Documentation
--------------
+Section 2 - Getting Started
+---------------------------
 
 .. toctree::
     :maxdepth: 1
 
-    src/documentation
+    src/getting_started
     src/typical_example
-    src/documentation-tutorial
-    src/documentation-examples
 
-Collaboration
--------------
+Section 3 - Extended documentation
+----------------------------------
 
 .. toctree::
     :maxdepth: 1
 
-    src/collaboration
-
-Tutorial and Examples
----------------------
-
-Tutorial and examples are in separate repositories. Before 
-using them, make sure to install the Hermes library in your 
-system.
-To get the tutorial, clone::
-
-    git clone git://github.com/hpfem/hermes-tutorial.git
+    src/documentation
+    src/documentation-tutorial
+    src/documentation-examples
+
+Section 4 - Collaboration
+-------------------------
 
-To get examples, clone::
+.. toctree::
+    :maxdepth: 1
 
-    git clone git://github.com/hpfem/hermes-examples.git
+    src/collaboration
 
-Both repositores contain a folder doc/ with documentation. To build 
-the documentation there, type "make html" in the doc/ directory.

doc/src/documentation-examples.rst

@@ -8,7 +8,7 @@ To get the hermes-examples repository, clone::
 
     git clone git://github.com/hpfem/hermes-examples.git
 
-After cloning, go to hermes-examples/doc folder and type "make html" in the doc/ directory.
+After cloning, go to hermes-examples/doc folder and type "make" in the doc/ directory.
 
 Please refer to the documentation there for the instructions how to install the examples in the hermes-examples repository and for
 the step-by-step examples descriptions.

doc/src/documentation-tutorial.rst

@@ -8,7 +8,7 @@ To get the hermes-tutorial repository, clone::
 
     git clone git://github.com/hpfem/hermes-tutorial.git
 
-After cloning, go to hermes-tutorial/doc folder and type "make html" in the doc/ directory.
+After cloning, go to hermes-tutorial/doc folder and type "make" in the doc/ directory.
 
 Please refer to the documentation there for the instructions how to install the tutorial in the hermes-tutorial repository and for
 the step-by-step tutorials descriptions.