diff --git a/README.md b/README.md index 5959ea46907412793448508c864700e870a64b9d..3fa36ed0d34ebbffada0a5657b2d3f4516ae7b05 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 36ff4023be0ae5903c1f556aca4cbef8bcbeb0ba..b4d8093dddb635d48dc5223eb0c1e9bbe8d19c3c 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: