From d8c2d7c72eeb6e99bed350711d75da6ee738d0fd Mon Sep 17 00:00:00 2001 From: Jukka Aho Date: Sun, 5 Jul 2015 00:36:01 +0300 Subject: [PATCH] added structure for documentation --- docs/api/index.rst | 4 ++++ docs/index.rst | 5 +++-- docs/introduction.rst | 6 ++++++ docs/tutorials/index.rst | 9 +++++++++ 4 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 docs/api/index.rst create mode 100644 docs/introduction.rst create mode 100644 docs/tutorials/index.rst diff --git a/docs/api/index.rst b/docs/api/index.rst new file mode 100644 index 0000000..57ef4db --- /dev/null +++ b/docs/api/index.rst @@ -0,0 +1,4 @@ +API Documentation +================= + +Automatically generated apidoc comes here. diff --git a/docs/index.rst b/docs/index.rst index 7f984e5..cbf9e10 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,13 +1,14 @@ JuliaFEM ======== -.. include:: ../readme.rst +.. include:: ../README.rst Contents: .. toctree:: :maxdepth: 2 - readme + introduction api/index + tutorials/index diff --git a/docs/introduction.rst b/docs/introduction.rst new file mode 100644 index 0000000..a833f4a --- /dev/null +++ b/docs/introduction.rst @@ -0,0 +1,6 @@ +============ +Introduction +============ + +This is JuliaFEM. + diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst new file mode 100644 index 0000000..a331dcb --- /dev/null +++ b/docs/tutorials/index.rst @@ -0,0 +1,9 @@ +Tutorials +========= + +Tutorials are automatically generated. Current status of notebooks: + +| id | Notebook | Runtime | Status| +|----|----------|---------|-------| +|1|2015-07-04-hello-world-functional-tests-part-2.ipynb|17.6|0| +|2|2015-07-04-hello-world-functional-tests.ipynb|16.01|1|