Merge pull request #517 from mleotta/dev/replace-pdf-with-rtd

Replaced the PDF user guide with readthedocs
Kitware · Aug 31, 2021 · 64cce16 · 64cce16
2 parents 2b667c8 + db45d4e
commit 64cce16
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -20,7 +20,7 @@ TeleSculptor can be installed from precompiled binaries for Linux, MacOS, and
 Windows included at the bottom of the
 `latest release`_ page by following the instructions in the Installation_ section.
 Instructions on how to use the TeleSculptor GUI can be found in
-the `User Guide <doc/TeleSculptor-v1.1-User-Guide.pdf>`_. A computer with at
+the `User Guide`_. A computer with at
 least 16GB of RAM is recommended for processing most datasets.
 
 More advanced users who wish to build the project from source should proceed to the
@@ -95,7 +95,7 @@ TeleSculptor application into the Applications folder.
 
 The remainder of this document is aimed at developers who wish to build the
 project from source.  For end users looking for instruction on running the GUI
-application please read the `User Guide <doc/TeleSculptor-v1.1-User-Guide.pdf>`_.
+application please read the `User Guide`_.
 
 
 Building TeleSculptor
@@ -350,6 +350,7 @@ public release via 88ABW-2015-2555.
 .. _VisualSFM: http://ccwu.me/vsfm/
 .. _VTK: https://vtk.org/
 .. _latest release: https://github.com/Kitware/TeleSculptor/releases/latest
+.. _User Guide: https://telesculptor.readthedocs.io/en/latest/
 
 .. Appendix II: Text Substitutions
 .. ===============================

diff --git a/doc/TeleSculptor-v1.1-User-Guide.pdf b/doc/TeleSculptor-v1.1-User-Guide.pdf
diff --git a/examples/README.rst b/examples/README.rst
@@ -5,7 +5,7 @@
 We recommend that new users try one of the following videos released as part
 of the `VIRAT Video Dataset`_. You will need to accept the Terms of Use before
 you proceed to the download. For a thorough description of TeleSculptor
-workflows, please see the `User Guide <../doc/TeleSculptor-v1.1-User-Guide.pdf>`_.
+workflows, please see the `User Guide`_.
 
 
 09172008flight1tape3_2.mpg_: The aircraft makes about one complete orbit over
@@ -37,3 +37,4 @@ substantial overlap in the content seen between different images.
 .. _Kitware: http://www.kitware.com/
 .. _09152008flight2tape2_4.mpg: https://data.kitware.com/#item/56f580488d777f753209c72f
 .. _09172008flight1tape3_2.mpg: https://data.kitware.com/#item/5ef11b419014a6d84ed53971
+.. _User Guide: https://telesculptor.readthedocs.io/en/latest/