Skip to content

Commit

Permalink
include docs link and build steps
Browse files Browse the repository at this point in the history
  • Loading branch information
averagehat committed Mar 30, 2016
1 parent df39b43 commit 61cc534
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,16 @@ You can pseudo test the installation of the pipeline by running the functional t
.. code-block:: bash
ngs_mapper/tests/slow_tests.sh
Documentation
-------------
The documentation is available to view online at http://ngs-mapper.readthedocs.org/en/latest/ By default this site always shows the latest documentation; you can select your verion by clicking `v:latest` in the bottom left menu, then selecting your version number from `Versions.`

If for any reason you need to use the documentation locally, you can build it:

.. code-block:: bash
cd doc
make clean && make html
firefox build/html/install.html#build-and-view-complete-documentation
cd ..

0 comments on commit 61cc534

Please sign in to comment.