Add links for user and developer documentation and a basic blurb desc…

…ribing the package
SasView · Sep 28, 2023 · dc394a7 · dc394a7
1 parent 889453e
commit dc394a7
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 6 deletions.
diff --git a/docs/source/dev/dev.rst b/docs/source/dev/dev.rst
@@ -0,0 +1,6 @@
+.. dev.rst
+
+.. _dev:
+
+Developer Documentation
+=======================
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,18 +3,25 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to sasdata's documentation!
-===================================
+SasData Documentation
+=====================
+
+.. note:: In Windows use [Alt]-[Cursor left] to return to the previous page
+
+Contents
+--------
+
+**SasData** is a Python library for importing and exporting reduced small-angle scattering data.
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1
 
+   User Documentation <user/user>
 
+   Developer Documentation <dev/dev>
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+* :ref:`search`
diff --git a/docs/source/user/user.rst b/docs/source/user/user.rst
@@ -0,0 +1,6 @@
+.. user.rst
+
+.. _user:
+
+User Documentation
+==================