Changeset 390494d in sasview for docs

Timestamp:

Feb 22, 2019 9:52:14 AM (6 years ago)

Author:

GitHub <noreply@…>

Branches:

ESS_GUI, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_opencl, ESS_GUI_sync_sascalc

Children:

1078936c, 44a698c

Parents:

091eee64 (diff), afdb3b3 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

git-author:

Piotr Rozyczko <piotr.rozyczko@…> (02/22/19 09:52:14)

git-committer:

GitHub <noreply@…> (02/22/19 09:52:14)

Message:

Merge pull request #206 from mrakitin/fix_installer

FIX: add a proper entry point

Location:

docs/sphinx-docs/source

Files:

• index.rst (modified) (1 diff)
• user/RELEASE.rst (added)
• user/marketplace.rst (modified) (2 diffs)
• user/tutorial.rst (modified) (1 diff)

docs/sphinx-docs/source/index.rst

@@ -10 +10 @@
    :maxdepth: 1
 
-   User Documentation <user/user>
+   USER DOCUMENTATION <user/user>
 
-   Developer Documentation <dev/dev>
+   DEVELOPER DOCUMENTATION <dev/dev>
+   
+   Release Notes <user/RELEASE>
+   

docs/sphinx-docs/source/user/marketplace.rst

@@ -6 +6 @@
 plug-in fitting models for *SasView* for all to use.
 
-.. note:: These plug-in models require SasView version 4.0 or later.
+.. note:: 
+    These plug-in models require SasView version 4.0 or later. However, 
+    not *all* models may work with *every* version of SasView because 
+    of changes to our API.
 
 Contributed models should be written in Python (only version 2.7.x is
@@ -12 +15 @@
 combination of Python and C. You only need to upload the .py/.c source
 code files to the Marketplace!
+
+Please put a comment in your code to indicate which version of SasView you 
+wrote the model for.
 
 For guidance on how to write a plugin model see :ref:`Writing_a_Plugin` . It

docs/sphinx-docs/source/user/tutorial.rst

@@ -8 +8 @@
 .. note:: In Windows use [Alt]-[Cursor left] to return to the previous page
 
+The following tutorial was written for Version 2.x but is still a useful overview of 
+much of the analysis capability in SasView (but disregard Appendix XIII if using 
+Version 4.2 or later)
+
+:download:`Old Tutorial <sasview/Tutorial.pdf>`
+
+The following tutorials have been written for Version 4.x
+
 :download:`Getting Started with Sasview <sasview/getting_started_with_sasview.pdf>`
 
-:download:`Old Tutorial <sasview/Tutorial.pdf>`
+:download:`Basic 1D Fitting in Sasview <sasview/basic_1d_fitting_in_sasview_v3x_4x.pdf>`
+
+:download:`Simultaneous 1D Fitting in Sasview <sasview/simultaneous_1d_fitting_in_sasview_v3x_4x.pdf>`
+
+:download:`Correlation Function Analysis in SasView <sasview/correlation_function_analysis_in_sasview_v4x.pdf>`