add subpages to docs

UniStuttgart-VISUS · Jun 24, 2024 · 3b5c02e · 3b5c02e
1 parent e4f5dad
commit 3b5c02e
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 4 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,2 +1,8 @@
 0.1
------
+-----
+Features in first version:
+* Uncertainty-aware Principle Component Analysis
+* Uncertainty-aware Multi-dimensional Scaling
+* Basic visualizations: 
+    * N-dimensional distributions: scatterplot matrices, iso-lines of probability distribution, 
+    * 1D distributions: box plots, violin plots, dot plots
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,8 +11,8 @@ Welcome to UADAPy's documentation!
    :caption: Contents:
 
    Changelog :doc:`./changelog.rst`
-   Installation <installation.rst>
-   Examples <examples.rst>
+   Installation :doc:`./installation.rst`
+   Examples :doc:`./examples.rst`
 
 
 Indices and tables

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -1 +1,10 @@
-Installation instructions go here
+Installation
+============
+Installation via pip
+------------------
+You can install the library by typing:
+.. code-block:: bash
+
+    pip install git+https://github.com/UniStuttgart-VISUS/uadapy
+
+The library was tested under Windows.