From 38a2105e95398ce2df8dc5ee3d7c07f591fccf57 Mon Sep 17 00:00:00 2001 From: Jukka Aho Date: Sun, 5 Jul 2015 01:28:20 +0300 Subject: [PATCH] updated documentation --- README.rst | 44 ++++++++++++++++++++++++------------------- docs/api/index.rst | 7 +++++++ docs/conf.py | 5 ++++- docs/index.rst | 9 ++++----- docs/last_updated.rst | 1 + 5 files changed, 41 insertions(+), 25 deletions(-) create mode 100644 docs/last_updated.rst diff --git a/README.rst b/README.rst index 7c1fa82..dc32fbe 100644 --- a/README.rst +++ b/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/) -``` - 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. -``` +`The Zen of Python `_ -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 `_. + +Contributors: see `contributors `_ diff --git a/docs/api/index.rst b/docs/api/index.rst index 57ef4db..ec9394a 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -2,3 +2,10 @@ API Documentation ================= Automatically generated apidoc comes here. + +Contents: + +.. toctree:: + :maxdepth: 2 + + JuliaFEM.elasticity_solver.md diff --git a/docs/conf.py b/docs/conf.py index 1aa5b1b..e70a833 100644 --- a/docs/conf.py +++ b/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 diff --git a/docs/index.rst b/docs/index.rst index cbf9e10..7dc6a50 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,14 +1,13 @@ -JuliaFEM -======== - .. include:: ../README.rst +.. include:: last_updated.rst + Contents: .. toctree:: :maxdepth: 2 - introduction - api/index + ../README.rst tutorials/index + api/index diff --git a/docs/last_updated.rst b/docs/last_updated.rst new file mode 100644 index 0000000..f9df745 --- /dev/null +++ b/docs/last_updated.rst @@ -0,0 +1 @@ +Documentation last updated (UTC): UNKNOWN