Updated docs/getting started to be more helpful

ilent2 · Mar 27, 2020 · c1f9953 · c1f9953
1 parent 4d8ebc3
commit c1f9953
Show file tree

Hide file tree

Showing 10 changed files with 316 additions and 104 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ There are several methods for installing the toolbox.
 If using Matlab, the easiest method is to launch Matlab and
 navigate to Home -> Addons -> Get-Addons and search for
 "Optical Tweezers Toolbox".  Then, simply click the
-"Add from GitHub" button to automatially download the package and
+"Add from GitHub" button to automatically download the package and
 add it to the path.
 Alternatively, you can download the toolbox directly from the
 [GitHub repository](https://github.com/ilent2/ott) or select a
@@ -49,6 +49,9 @@ or for the graphical user interface
 ott.ui.Launcher
 ```
 
+More detailed instructions can be found in the Getting Started
+section of the [documentation](https://ott.readthedocs.io/).
+
 Dependencies
 ------------
 
@@ -65,8 +68,8 @@ We are currently working on a full list; however, if you encounter any
 difficulties with missing dependencies, please let us know and we may
 be able to find a workaround.
 
-Getting started
----------------
+Quick-start guide
+-----------------
 
 The toolbox has changed a lot since previous releases, the most notable
 change is addition of a graphical user interface (still a work-in-progress)
@@ -158,8 +161,8 @@ or by directly citing the toolbox
 and the respective Bibtex entry
 
 ```latex
-@misc{Nieminen2018,
-  author = {Lenton, Isaac C. D. and Nieminen, Timo A. and Loke, Vincent L. Y. and Stilgoe, Alexander B. and Kn{\ifmmode\ddot{o}\else\"{o}\fi}ner, Gregor and Bra{\ifmmode\acute{n}\else\'{n}\fi}czyk, Agata M. and Heckenberg, Norman R. and Rubinsztein-Dunlop, Halina},
+@misc{Lenton2020,
+  author = {Lenton, Isaac C. D. and Nieminen, Timo A. and Loke, Vincent L. Y. and Stilgoe, Alexander B. and Y. Hu and Kn{\ifmmode\ddot{o}\else\"{o}\fi}ner, Gregor and Bra{\ifmmode\acute{n}\else\'{n}\fi}czyk, Agata M. and Heckenberg, Norman R. and Rubinsztein-Dunlop, Halina},
   title = {Optical Tweezers Toolbox},
   year = {2020},
   publisher = {GitHub},

diff --git a/docs/Bsc.rst b/docs/Bsc.rst
@@ -1,3 +1,6 @@
+
+.. _bsc-classes:
+
 #############
 `Bsc` classes
 #############

diff --git a/docs/Calculating-forces-with-the-gui.rst b/docs/Calculating-forces-with-the-gui.rst
@@ -0,0 +1,15 @@
+
+.. _calculating-forces-with-the-gui:
+
+###############################
+Calculating forces with the GUI
+###############################
+
+.. contents::
+   :depth: 3
+..
+
+Information on exploring the toolbox with the UI
+
+.. todo:: Write this page
+
diff --git a/docs/Examples.rst b/docs/Examples.rst
@@ -1,11 +1,13 @@
 
+.. _examples:
 
 ########
 Examples
 ########
 
-This section provides detailed examples to help you get started using the toolbox.
-Further examples scripts and LiveScripts can be found in the ``examples`` directory.
+This section provides detailed examples to help you get started using
+the toolbox.  Further examples scripts and LiveScripts can be found
+in the ``examples`` directory.
 
 .. toctree::
    :maxdepth: 2
@@ -14,5 +16,5 @@ Further examples scripts and LiveScripts can be found in the ``examples`` direct
    Combining-beams
    Creating-a-custom-beam
    Creating-a-custom-Tmatrix
-   Exploring-the-toolbox-with-the-UI.rst
+   Calculating-forces-with-the-gui.rst
 
diff --git a/docs/Exploring-the-toolbox-with-the-UI.rst b/docs/Exploring-the-toolbox-with-the-UI.rst
diff --git a/docs/Further-Reading.rst b/docs/Further-Reading.rst
@@ -1,4 +1,6 @@
 
+.. _further-reading:
+
 ###############
 Further Reading
 ###############