Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation and project foundation updates
- Loading branch information
Showing
11 changed files
with
533 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| Ordered by date of first contribution: | ||
|
|
||
| * Ole Nielsen <ole.nielsen@aifdr.org> | ||
| * Tim Sutton <tim@linfiniti.com> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| See README.rst for installation instructions. |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
|
|
||
|
|
||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | ||
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
|
|
||
|
|
||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
|
|
||
| <title>About Risk-in-a-box — Risk-In-A-Box 0.0.1 documentation</title> | ||
|
|
||
| <link rel="stylesheet" href="_static/haiku.css" type="text/css" /> | ||
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | ||
| <link rel="stylesheet" href="_static/print.css" type="text/css" /> | ||
|
|
||
| <script type="text/javascript"> | ||
| var DOCUMENTATION_OPTIONS = { | ||
| URL_ROOT: '', | ||
| VERSION: '0.0.1', | ||
| COLLAPSE_INDEX: false, | ||
| FILE_SUFFIX: '.html', | ||
| HAS_SOURCE: true | ||
| }; | ||
| </script> | ||
| <script type="text/javascript" src="_static/jquery.js"></script> | ||
| <script type="text/javascript" src="_static/underscore.js"></script> | ||
| <script type="text/javascript" src="_static/doctools.js"></script> | ||
| <script type="text/javascript" src="_static/theme_extras.js"></script> | ||
| <link rel="top" title="Risk-In-A-Box 0.0.1 documentation" href="index.html" /> | ||
| <link rel="next" title="Class: Riab" href="riab.html" /> | ||
| <link rel="prev" title="Welcome to Risk-In-A-Box’s documentation!" href="index.html" /> | ||
| </head> | ||
| <body> | ||
| <div class="header"><h1 class="heading"><a href="index.html"> | ||
| <span>Risk-In-A-Box 0.0.1 documentation</span></a></h1> | ||
| <h2 class="heading"><span>About Risk-in-a-box</span></h2> | ||
| </div> | ||
| <div class="topnav"> | ||
|
|
||
| <p> | ||
| «  <a href="index.html">Welcome to Risk-In-A-Box’s documentation!</a> | ||
|   ::   | ||
| <a class="uplink" href="index.html">Contents</a> | ||
|   ::   | ||
| <a href="riab.html">Class: Riab</a>  » | ||
| </p> | ||
|
|
||
| </div> | ||
| <div class="content"> | ||
|
|
||
|
|
||
| <div class="section" id="about-risk-in-a-box"> | ||
| <h1>About Risk-in-a-box<a class="headerlink" href="#about-risk-in-a-box" title="Permalink to this headline">¶</a></h1> | ||
| <p>This is the project: Risk in a Box - QGIS plugin</p> | ||
| <p>The latest source code is available in <a class="reference external" href="https://github.com/AIFDR/risk_in_a_box">https://github.com/AIFDR/risk_in_a_box</a> | ||
| which contains modules for risk calculations, gis functionality and plugin | ||
| management.</p> | ||
| <p>For more information about Risk In a Box please look at | ||
| our documentation under docs/build/html.</p> | ||
| <div class="section" id="quick-installation-guide-users"> | ||
| <h2>Quick Installation Guide - Users<a class="headerlink" href="#quick-installation-guide-users" title="Permalink to this headline">¶</a></h2> | ||
| <p>To install the plugin, use the plugin manager in QGIS:</p> | ||
| <div class="highlight-python"><pre>Plugins -> Fetch Python Plugins</pre> | ||
| </div> | ||
| <p>Then search for ‘Risk In A Box’, select it and click the install button. The plugin will | ||
| now be added to your plugins menu.</p> | ||
| </div> | ||
| <div class="section" id="quick-installation-guide-developers"> | ||
| <h2>Quick Installation Guide - Developers<a class="headerlink" href="#quick-installation-guide-developers" title="Permalink to this headline">¶</a></h2> | ||
| <p>To develop on the plugin, you first need to copy it to your local system. If you are a developer, | ||
| the simplest way to do that is to clone it from our GitHub repository page like this:</p> | ||
| <div class="highlight-python"><pre>git clone git://github.com/AIFDR/risk_in_a_box.git</pre> | ||
| </div> | ||
| <p>Place the local repository under <cite>~/.qgis/python/plugins</cite> and then restart QGIS. If you wish to | ||
| an IDE for development, please refer to <a class="reference external" href="http://linfiniti.com/2011/12/remote-debugging-qgis-python-plugins-with-pydev/">this article</a> | ||
| for detailed information on how you can do so.</p> | ||
| <p>Contact: | ||
| <a class="reference external" href="mailto:Ole.Moller.Nielsen%40gmail.com">Ole<span>.</span>Moller<span>.</span>Nielsen<span>@</span>gmail<span>.</span>com</a></p> | ||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
| <div class="bottomnav"> | ||
|
|
||
| <p> | ||
| «  <a href="index.html">Welcome to Risk-In-A-Box’s documentation!</a> | ||
|   ::   | ||
| <a class="uplink" href="index.html">Contents</a> | ||
|   ::   | ||
| <a href="riab.html">Class: Riab</a>  » | ||
| </p> | ||
|
|
||
| </div> | ||
|
|
||
| <div class="footer"> | ||
| © Copyright 2012, Ole Moller. | ||
| Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2. | ||
| </div> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| =================== | ||
| About Risk-in-a-box | ||
| =================== | ||
|
|
||
| This is the project: Risk in a Box - QGIS plugin | ||
|
|
||
| The latest source code is available in https://github.com/AIFDR/risk_in_a_box | ||
| which contains modules for risk calculations, gis functionality and plugin | ||
| management. | ||
|
|
||
| For more information about Risk In a Box please look at | ||
| our documentation under docs/build/html. | ||
|
|
||
| Quick Installation Guide - Users | ||
| ================================ | ||
|
|
||
| .. note: | ||
|
|
||
| This is a plugin for `Quantum GIS <http://qgis.org>` (QGIS). It requires version 1.8 of QGIS | ||
| (or newer). | ||
|
|
||
| To install the plugin, use the plugin manager in QGIS:: | ||
|
|
||
| Plugins -> Fetch Python Plugins | ||
|
|
||
| Then search for 'Risk In A Box', select it and click the install button. The plugin will | ||
| now be added to your plugins menu. | ||
|
|
||
| Quick Installation Guide - Developers | ||
| ===================================== | ||
|
|
||
| To develop on the plugin, you first need to copy it to your local system. If you are a developer, | ||
| the simplest way to do that is to clone it from our GitHub repository page like this:: | ||
|
|
||
| git clone git://github.com/AIFDR/risk_in_a_box.git | ||
|
|
||
| Place the local repository under `~/.qgis/python/plugins` and then restart QGIS. If you wish to | ||
| an IDE for development, please refer to `this article <http://linfiniti.com/2011/12/remote-debugging-qgis-python-plugins-with-pydev/>`_ | ||
| for detailed information on how you can do so. | ||
|
|
||
| Contact: | ||
| Ole.Moller.Nielsen@gmail.com | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,7 @@ Contents: | |
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| README | ||
| riab | ||
| riabdialog | ||
| riabdialogtest | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../../README.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,7 @@ Contents: | |
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| README | ||
| riab | ||
| riabdialog | ||
| riabdialogtest | ||
|
|
||