updated documentation

README.rst

@@ -1,15 +1,21 @@
-![JuliaFEMLogo](https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/docs/logo/JuliaFEMLogo_256x256.png) 
+========
-# JuliaFEM 
+JuliaFEM
+========
 
-[![Join the chat at https://gitter.im/JuliaFEM/JuliaFEM](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JuliaFEM/JuliaFEM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+The JuliaFEM project develops open-source software for reliable, scalable, distributed Finite Element Method.
 
-Build Status: [![Build Status](https://travis-ci.org/JuliaFEM/JuliaFEM.jl.svg?branch=master)](https://travis-ci.org/JuliaFEM/JuliaFEM.jl)
+.. image:: https://badges.gitter.im/Join%20Chat.svg
+  :target: https://gitter.im/JuliaFEM/JuliaFEM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
+.. image:: https://travis-ci.org/JuliaFEM/JuliaFEM.jl.svg?branch=master
+  :target: https://travis-ci.org/JuliaFEM/JuliaFEM.jl
+
+.. image:: https://coveralls.io/repos/JuliaFEM/JuliaFEM.jl/badge.svg?branch=master
+  :target: https://coveralls.io/r/JuliaFEM/JuliaFEM.jl?branch=master
 
-Code Coverage: [![Coverage Status](http://coveralls.io/repos/JuliaFEM/JuliaFEM.jl/badge.svg?branch=master)](https://coveralls.io/r/JuliaFEM/JuliaFEM.jl?branch=master)
 
 Documentation: http://www.juliaFEM.org
 
-The JuliaFEM project develops open-source software for reliable, scalable, distributed Finite Element Method.
 
 The JuliaFEM software library is a framework that allows for the distributed processing of large Finite Element Models across clusters of computers using simple programming models. It is designed to scale up from single servers to thousands of machines, each offering local computation and storage. The basic design principle is: everything is nonlinear. All physics models are nonlinear from which the linearization are made as a special cases. 
 
@@ -29,18 +35,18 @@ Initial road map for JuliaFEM:
 
 We strongly believe in the test driven development as well as building on top of previous work. Thus all the new code in this project should be 100% tested. Also other people have wisdom in style as well:
 
-[The Zen of Python](https://www.python.org/dev/peps/pep-0020/)
+`The Zen of Python <https://www.python.org/dev/peps/pep-0020/>`_
-```
-    Beautiful is better than ugly.
-    Explicit is better than implicit.
-    Simple is better than complex.
-    Complex is better than complicated.
-    Flat is better than nested.
-    Sparse is better than dense.
-    Readability counts.
-    Errors should never pass silently.
-```
 
-Interested in participating? Please start by reading  [CONTRIBUTING.md](https://github.com/JuliaFEM/JuliaFEM/blob/master/CONTRIBUTING.md).
+|    Beautiful is better than ugly.
+|    Explicit is better than implicit.
+|    Simple is better than complex.
+|    Complex is better than complicated.
+|    Flat is better than nested.
+|    Sparse is better than dense.
+|    Readability counts.
+|    Errors should never pass silently.
 
-Contributors: see [contributors](https://github.com/JuliaFEM/JuliaFEM/blob/master/contributors)
+
+Interested in participating? Please start by reading `CONTRIBUTING.md <https://github.com/JuliaFEM/JuliaFEM/blob/master/CONTRIBUTING.md>`_.
+
+Contributors: see `contributors <https://github.com/JuliaFEM/JuliaFEM/blob/master/contributors>`_

docs/api/index.rst

@@ -2,3 +2,10 @@ API Documentation
 =================
 
 Automatically generated apidoc comes here.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   JuliaFEM.elasticity_solver.md

docs/conf.py

@@ -17,7 +17,10 @@ import os
 import juliadoc
 import shlex
 import sphinx_rtd_theme
+import datetime
 
+with open("last_updated.rst", "w") as fh:
+    fh.write("Documentation last updated (UTC): {0}".format(str(datetime.datetime.utcnow())))
 
 extensions = ['juliadoc.julia', 'juliadoc.jlhelp']
 html_theme_path = [juliadoc.get_theme_dir(), sphinx_rtd_theme.get_html_theme_path()]
@@ -145,7 +148,7 @@ html_show_copyright = False
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = './logo/JuliaFEMLogo_256x256.png'
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32

docs/index.rst

@@ -1,14 +1,13 @@
-JuliaFEM
-========
-
 .. include:: ../README.rst
 
+.. include:: last_updated.rst
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-   introduction
+   ../README.rst
-   api/index
    tutorials/index
+   api/index
 

docs/last_updated.rst

@@ -0,0 +1 @@
+Documentation last updated (UTC): UNKNOWN