From dd504cb3a1a4f24f583133d538f1f1fbffaea470 Mon Sep 17 00:00:00 2001 From: Valerio Mariani <valerio.mariani@desy.de> Date: Tue, 10 Jul 2018 17:38:00 +0200 Subject: [PATCH] Updated documentation --- README.md | 2 +- docs/index.rst | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5959ea4..3fa36ed 100644 --- a/README.md +++ b/README.md @@ -35,4 +35,4 @@ Installation Methods Documentation ------------- -The API documentation can be found on Read The Docs \ No newline at end of file +The API documentation can be found on [Read The Docs](https://cfelpyutils.readthedocs.io/en/latest) diff --git a/docs/index.rst b/docs/index.rst index 36ff402..b4d8093 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,11 @@ Welcome to cfelpyutils's documentation! ======================================= +CfelPyUtils is a library of several utility functions and +classes used by several software projects developed at the +Center For Free Electron Laser Science (CFEL) in Hamburg. + + .. toctree:: :maxdepth: 4 :caption: Contents: -- GitLab