merging docs changes from master

CosmiQ · Jul 18, 2019 · 5c01053 · 5c01053
2 parents aff07c7 + d0c4592
commit 5c01053
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -67,15 +67,11 @@ The package also exists on[ PyPI](https://pypi.org), but note that some of the d
 
 ```
 conda install -c conda-forge rtree gdal=2.4.1
-```
-If you don't want to use `conda`, you can [install libspatialindex](https://libspatialindex.org), then `pip install rtree`. Installing GDAL without conda can be very difficult and approaches vary dramatically depending upon the build environment and version, but online resources may help with specific use cases.
-
-Once you have that dependency set up, install as usual using `pip`:
-
-```
 pip install solaris
 ```
 
+If you don't want to use `conda`, you can [install libspatialindex](https://libspatialindex.org), then `pip install rtree`. Installing GDAL without conda can be very difficult and approaches vary dramatically depending upon the build environment and version, but [the rasterio install documentation](https://rasterio.readthedocs.io/en/stable/installation.html) provides OS-specific install instructions. Simply follow their install instructions, replacing `pip install rasterio` with `pip install solaris` at the end.
+
 <!-- #### Docker
 
 You may also use our Docker container:

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -6,7 +6,6 @@ Installing ``solaris``
 
 There are several methods available for installing `solaris <https://github.com/cosmiq/solaris>`_:
 
-* :ref:`conda-forge` **(recommended)**
 * :ref:`github-install`
 * :ref:`pip-only` *use at your own risk!*
 
@@ -26,23 +25,6 @@ If you're just going to work with your own data, you can skip these steps.
 
 --------------
 
-.. _conda-forge:
-
-Installing from ``conda-forge``
-===============================
-**This is the recommended installation method.**
-
-If you have `anaconda`_ installed,
-you can create a new ``conda`` environment and install ``solaris`` there with ease::
-
-  conda create solaris python=3.6 solaris -c conda-forge
-
-We recommend installing ``solaris`` in a new environment to avoid conflicts with
-existing installations of packages (``GDAL`` incompatibility being the usual problem),
-but installing ``solaris`` in an existing environment can work in some cases.
-
-----------
-
 .. _github-install:
 
 Installing from GitHub using a ``conda`` environment and ``pip``

diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst
@@ -30,7 +30,7 @@ The command line interface (CLI) is the simplest way to use Solaris. Using the C
 you can run training and/or prediction on overhead imagery using `SpaceNet <https://www.spacenet.ai>`_ models
 without writing a single line of python code.
 
-After `installing Solaris <../installation.html>`_, you can run simple commands from a
+After :doc:`installing Solaris <../installation>`, you can run simple commands from a
 terminal or command prompt for standard operations, from creating training masks
 using vector labels to running an entire deep learning pipeline through
 evaluating model performance. Instead of having to write code to help ``solaris``
@@ -58,7 +58,7 @@ analysis of overhead imagery data:
 * The ability to use pre-trained or freshly initialized `SpaceNet <https://www.spacenet.ai>`_ models, as well as your own custom models
 * Model performance evaluation tools for the SpaceNet IoU metric (APLS coming soon!)
 
-The `Python API Reference <../api/index.html>`_ provides full documentation of
+The :doc:`Python API Reference <../api/index>` provides full documentation of
 everything described above and more. For usage examples to get you started, see
 the tutorials below.
 
@@ -73,7 +73,7 @@ the tutorials below.
 
 Reference
 =========
-* `API reference <../api/index>`_
+* :doc:`API reference <../api/index>`
 
 Index
 =====