From 3a398b6c623c907915192be47fb09a22a27fbed8 Mon Sep 17 00:00:00 2001
From: thielfab <fabian.thiel@hu-berlin.de>
Date: Wed, 24 Jan 2018 17:42:45 +0100
Subject: [PATCH] added logo, restructured TOC, smaller text edits
---
doc/source/conf.py | 4 +-
doc/source/img/logo2.png | Bin 0 -> 129 bytes
doc/source/img/settings_plugin_enable.png | Bin 0 -> 130 bytes
doc/source/index.rst | 48 +++++++++---------
.../{installation.md => installation.rst} | 38 ++++++++++----
doc/source/news.md | 12 -----
doc/source/news.rst | 14 +++++
7 files changed, 67 insertions(+), 49 deletions(-)
create mode 100644 doc/source/img/logo2.png
create mode 100644 doc/source/img/settings_plugin_enable.png
rename doc/source/{installation.md => installation.rst} (64%)
delete mode 100644 doc/source/news.md
create mode 100644 doc/source/news.rst
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 425df3f1..7e0c803e 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -93,9 +93,11 @@ todo_include_todos = True
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
+html_logo = 'img/logo2.png'
+
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
diff --git a/doc/source/img/logo2.png b/doc/source/img/logo2.png
new file mode 100644
index 0000000000000000000000000000000000000000..b815fd89c797c57ad4ea1056e31f6484b87be3b1
GIT binary patch
literal 129
zcmWN?%MrpL5CG6SRnUL|cKN0oghiN9$+#p3tJimV7kzllx9n>jyest>>-KEC{qN^}
zEAyrJprS4#=BSc;2IqI3Qv(epLdNERlBwW*@-|_j0L4KdU7aPw>|OMsrB<zuIX4p!
MQSkVZv}i#50GI(LP5=M^
literal 0
HcmV?d00001
diff --git a/doc/source/img/settings_plugin_enable.png b/doc/source/img/settings_plugin_enable.png
new file mode 100644
index 0000000000000000000000000000000000000000..75fbc65b3aa3f05898aa50266790331022713923
GIT binary patch
literal 130
zcmWN?K@!3s3;@78ujmIX5RioahK9s4qtcPK2Vbvy*-Jj7_4l+L$37NoAMLn3b<F>_
zbDg=r?AV3v<xOvO8e4&TS~Rj!jLap`s+e;jW$!{N3?Pag5Ku}%h~%WMIXMc|31J4H
N8q8>4nG#{}<_7>3Cw>3`
literal 0
HcmV?d00001
diff --git a/doc/source/index.rst b/doc/source/index.rst
index febb2398..5fa1ede1 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -3,12 +3,18 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
+======================
HUB Time Series Viewer
-================================================
+======================
+
+**Welcome to the HUB Time Series Viewer Documentation!**
+
+
About
-----
-The Humboldt-Universität zu Berlin (HUB) Time Series Viewer is a QGIS Plugin to visualize raster based earth observation time series data.
+
+The Humboldt-Universität zu Berlin (HUB) Time Series Viewer (TSV) is a QGIS Plugin to visualize raster based earth observation time series data.
Its major aims are:
@@ -18,39 +24,19 @@ Its major aims are:
.. image:: img/screenshot1.png
-.. toctree::
- :maxdepth: 2
- :caption: Contents:
- :local:
-
-
-
-News
-----
-2018-01-19: Re-written dialog to configure map visualizations ("Map Views"), Vector & Raster layers can be hidden
-
-2018-01-19: Re-written dialog to configure map visualizations ("Map Views"), Vector & Raster layers can be hidden
-
-2017-06-27: `Poster <https://bitbucket.org/jakimowb/hub-timeseriesviewer/downloads/Jakimow.et.al.TimeSeriesViewer.pdf>`_ & demonstration at `Multitemp 2017, Brugges, Belgium <https://multitemp2017.vito.be>`_.
-
-2017-05-21: many changes, done in development branch "develop", e.g. QGIS MapCanvases for interactive maps, temporal profiles and more.
-
-2017-02-14: first setup for test users in the recent development branch qgis_apo
-
-2016-12-02: Work on this project continued. During the last months I focused on the `EnMAP-Box <https://bitbucket.org/hu-geomatics/enmap-box>`_ where I gained a lot of experience in using Qt and QGIS API.
-
Features
--------
* Raster images can be added to the time series without homogenisation of spatial extent or coordinate reference system. Time stamps are extracted automatically from (i) image meta data ("acquisition date"), (ii) the file name or (iii) the file directory path.
-* Raster IO uses the `Geospatial Data Abstraction Library (GDAL) <http://www.gdal.org>`_, which supports up to 142 `raster image formats <http://www.gdal.org/formats_list.html>`_ different raster formats.
+* Raster IO uses the `Geospatial Data Abstraction Library (GDAL) <http://www.gdal.org>`_, which supports up to 142 `different raster formats <http://www.gdal.org/formats_list.html>`_.
* Distinguished sensors by pixel size and number of bands and, if available, band wavelength information and sensor name.
* Spatial-temporal ("maps") visualisation allows to show multiples band combinations in parallel, e.g. True Color and coloured infrared.
* Color stretches are applied to all raster images of same sensor and band combination. This helps to optimise color stretches for multiple images in a minimum of time.
* Spectral-temporal ("time profile") visualisation shows raw or scaled, sensor specific band values.
+
Missing Features / Outlook
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -60,7 +46,10 @@ Missing Features / Outlook
* export spectral libraries
* show location of selected spectra
-Your feedback (wishes, comments, bugs, ...) is always welcome. Add it to the `issue section <https://bitbucket.org/jakimowb/sensecarbontsviewer/issues>`_
+Feedback
+~~~~~~~~
+
+Your feedback (wishes, comments, bugs, ...) is always welcome. Add it to the `issue section <https://bitbucket.org/jakimowb/hub-timeseriesviewer/issues?status=new&status=open>`_
or send me an email `benjamin.jakimow@geo.hu-berlin.de <benjamin.jakimow@geo.hu-berlin.de>`_.
@@ -71,6 +60,15 @@ License and Use
This program is free software; you can redistribute it and/or modify it under the terms of the `GNU General Public License Version 3 (GNU GPL-3) <https://www.gnu.org/licenses/gpl-3.0.en.html>`_ , as published by the Free Software Foundation.
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ news.rst
+ installation.rst
+ License <LICENSE.md>
+
+
Indices and tables
==================
diff --git a/doc/source/installation.md b/doc/source/installation.rst
similarity index 64%
rename from doc/source/installation.md
rename to doc/source/installation.rst
index b98e533f..3ab67375 100644
--- a/doc/source/installation.md
+++ b/doc/source/installation.rst
@@ -1,37 +1,53 @@
-# Installation #
-## A. Standard QGIS Plugin Installation ##
+
+============
+Installation
+============
+
+
+.. warning:: Time Series Viewer requires QGIS Version 2.18.xx
+
+A. Standard QGIS Plugin Installation
+------------------------------------
+
1. Download the most recent zip archive of the HUB TimeSeriesViewer QGIS Plugin from https://bitbucket.org/jakimowb/hub-timeseriesviewer/downloads
2. Extract the ``timeseriesviewerplugin`` folder and copy it to the user' QGIS python plugin directory
``~/.qgis2/python/plugins/timeseriesviewerplugin``
Alternatively, you can choose any other folder ``my/qgis/plugins/timeseriesviewerplugin`` if your ensure that it is known to the QGIS_PLUGINPATH:
- * In QGIS, got to Settings >> Options >> System.
+ * In QGIS, go to Settings >> Options >> System.
* Enable the Environment group box.
* Create a new entry that append ``my/qgis/plugins`` to the variable ``QGIS_PLUGINPATH``.
3. Finally restart QGIS, open the Plugin Manager and enable the HUB-TimeSeriesViewer.
+.. image:: img/settings_plugin_enable.png
+ :width: 80%
+ :align: center
+
+B. Developers
+-------------
-## B. Developers ##
-You really want to use [git](https://en.wikipedia.org/wiki/Git_%28software%29) to install and update the viewer.
+You really want to use `git <https://en.wikipedia.org/wiki/Git_%28software%29>`_ to install and update the viewer.
-If git is not available in your shell, you can download it from [https://git-scm.com/downloads](https://git-scm.com/downloads). You can install git without admin rights.
+If git is not available in your shell, you can download it from `<https://git-scm.com/downloads>`_. You can install git without admin rights.
-Larger binary files, e.g. for exemplary data, will are distributed via the Git Large File Storage (lfs) extension [https://git-lfs.github.com](https://git-lfs.github.com).
+Larger binary files, e.g. for exemplary data, will are distributed via the Git Large File Storage (lfs) extension `<https://git-lfs.github.com>`_.
-1. Open your shell and clone the repository into a local QGIS Python Plugin Folder
+1. Open your shell and clone the repository into a local QGIS Python Plugin Folder::
cd %USERPROFILE%\.qgis2\python\plugins
git clone https://bitbucket.org/jakimowb/hub-timeseriesviewer.git
-2. Checkout the development branch (this might change with the fist stable master version)
+2. Checkout the development branch (this might change with the fist stable master version)::
+
git checkout development
git lfs checkout
3. Start QGIS, go to Plugins -> Manage and Install and enable the "HUB TimeSeriesViewer" Plugin
-4. Download updates if available
+4. Download updates if available::
cd %USERPROFILE%\.qgis2\python\plugins\hub-timeseriesviewer
- git pull
\ No newline at end of file
+ git pull
+
diff --git a/doc/source/news.md b/doc/source/news.md
deleted file mode 100644
index c0b20a8f..00000000
--- a/doc/source/news.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# News #
-2017-06-27: [Poster](https://bitbucket.org/jakimowb/hub-timeseriesviewer/downloads/Jakimow.et.al.TimeSeriesViewer.pdf) & demo presentation at [Multitemp 2017](https://multitemp2017.vito.be)
-
-2017-05-21: many changes, done in development branch "develop", e.g:
- QGIS MapCanvases for interactive maps, temporal profiles, ...
- Feel free to test it if you like, but please note that it is still not stable.
-
-2017-02-14: first setup for test users in the recent development branch qgis_apo
-
-2016-12-02: Work on this project continued. During the last months I focused on
-the [EnMAP-Box](https://bitbucket.org/hu-geomatics/enmap-box) where I gained a lot of experience in using Qt and QGIS API.
-Referring to this, I created the [qgis_api](/branch/qgis_api) which contains the most recent developments.
diff --git a/doc/source/news.rst b/doc/source/news.rst
new file mode 100644
index 00000000..b36948bd
--- /dev/null
+++ b/doc/source/news.rst
@@ -0,0 +1,14 @@
+====
+News
+====
+
+
+2018-01-19: Re-written dialog to configure map visualizations ("Map Views"), Vector & Raster layers can be hidden
+
+2017-06-27: `Poster <https://bitbucket.org/jakimowb/hub-timeseriesviewer/downloads/Jakimow.et.al.TimeSeriesViewer.pdf>`_ & demonstration at `Multitemp 2017, Brugges, Belgium <https://multitemp2017.vito.be>`_.
+
+2017-05-21: many changes, done in development branch "develop", e.g. QGIS MapCanvases for interactive maps, temporal profiles and more.
+
+2017-02-14: first setup for test users in the recent development branch qgis_apo
+
+2016-12-02: Work on this project continued. During the last months I focused on the `EnMAP-Box <https://bitbucket.org/hu-geomatics/enmap-box>`_ where I gained a lot of experience in using Qt and QGIS API.
\ No newline at end of file
--
GitLab