From f0e59f41aac50661a7b7fb87b67bd3ebf12b826e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Stephan=20Mei=C3=9Fl?= <stephan.meissl@eox.at>
Date: Tue, 3 Mar 2020 10:51:53 +0100
Subject: [PATCH] More structure and first contents.
---
README.md | 5 ++-
documentation/operations-guide/Makefile | 4 ++
documentation/operations-guide/conf.py | 12 +++++-
documentation/operations-guide/index.rst | 3 +-
documentation/usage-guide/Makefile | 4 ++
documentation/usage-guide/conf.py | 12 +++++-
documentation/usage-guide/index.rst | 3 +-
documentation/usage-guide/web-client.md | 6 ---
documentation/usage-guide/web-client.rst | 47 ++++++++++++++++++++++++
9 files changed, 81 insertions(+), 15 deletions(-)
delete mode 100644 documentation/usage-guide/web-client.md
create mode 100644 documentation/usage-guide/web-client.rst
diff --git a/README.md b/README.md
index ab53ce0a..d99aa35b 100644
--- a/README.md
+++ b/README.md
@@ -206,7 +206,7 @@ docker exec -it $(docker ps -qf "name=emg-pvs_renderer") mv Emergency.sqlite /ca
## Installation
```bash
-python3 -m pip install spinx recommonmark
+python3 -m pip install spinx recommonmark sphinx-autobuild
```
## Generation
@@ -214,6 +214,9 @@ python3 -m pip install spinx recommonmark
```bash
make html
+# For watched html automatic building
+make html-watch
+
# For pdf output run:
make latex
make latexpdf
diff --git a/documentation/operations-guide/Makefile b/documentation/operations-guide/Makefile
index d4bb2cbb..4316687b 100644
--- a/documentation/operations-guide/Makefile
+++ b/documentation/operations-guide/Makefile
@@ -5,6 +5,7 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
+SPHINXAUTOBUILD ?= sphinx-autobuild
SOURCEDIR = .
BUILDDIR = _build
@@ -14,6 +15,9 @@ help:
.PHONY: help Makefile
+html-watch:
+ @$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
diff --git a/documentation/operations-guide/conf.py b/documentation/operations-guide/conf.py
index 24267b88..f02924ea 100644
--- a/documentation/operations-guide/conf.py
+++ b/documentation/operations-guide/conf.py
@@ -52,12 +52,20 @@ html_theme = 'alabaster'
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
+numfig = True
+numfig_format = {
+ 'figure': 'Figure %s',
+ 'table': 'Table %s',
+ 'code-block': 'Listing %s',
+ 'section': 'Section',
+}
+numfig_secnum_depth = 2
+
latex_documents = [(
'index',
'View-Server.tex',
u'View Server - Usage Guide',
- u'EOX IT Services GmbH \\and Fabian Schindler \\and Lubomir Bucek \\and \
- Mussab Abdalla \\and Stephan Meißl',
+ u'EOX IT Services GmbH',
'manual',
True
)]
diff --git a/documentation/operations-guide/index.rst b/documentation/operations-guide/index.rst
index b6c25866..9ab9492b 100644
--- a/documentation/operations-guide/index.rst
+++ b/documentation/operations-guide/index.rst
@@ -5,7 +5,6 @@ View Server - Operations Guide
.. toctree::
:maxdepth: 2
- :caption: Contents
intro
@@ -25,4 +24,4 @@ View Server - Operations Guide
.. only:: not builder_html
* :ref:`modindex`
- -- * :ref:`glossary`
+ .. * :ref:`glossary`
diff --git a/documentation/usage-guide/Makefile b/documentation/usage-guide/Makefile
index d4bb2cbb..4316687b 100644
--- a/documentation/usage-guide/Makefile
+++ b/documentation/usage-guide/Makefile
@@ -5,6 +5,7 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
+SPHINXAUTOBUILD ?= sphinx-autobuild
SOURCEDIR = .
BUILDDIR = _build
@@ -14,6 +15,9 @@ help:
.PHONY: help Makefile
+html-watch:
+ @$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
diff --git a/documentation/usage-guide/conf.py b/documentation/usage-guide/conf.py
index cd4aa38d..013dc104 100644
--- a/documentation/usage-guide/conf.py
+++ b/documentation/usage-guide/conf.py
@@ -52,12 +52,20 @@ html_theme = 'alabaster'
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
+numfig = True
+numfig_format = {
+ 'figure': 'Figure %s',
+ 'table': 'Table %s',
+ 'code-block': 'Listing %s',
+ 'section': 'Section',
+}
+numfig_secnum_depth = 2
+
latex_documents = [(
'index',
'View-Server.tex',
u'View Server - Usage Guide',
- u'EOX IT Services GmbH \\and Fabian Schindler \\and Lubomir Bucek \\and \
- Mussab Abdalla \\and Stephan Meißl',
+ u'EOX IT Services GmbH',
'manual',
True
)]
diff --git a/documentation/usage-guide/index.rst b/documentation/usage-guide/index.rst
index 50a41d48..50051a72 100644
--- a/documentation/usage-guide/index.rst
+++ b/documentation/usage-guide/index.rst
@@ -5,7 +5,6 @@ View Server - Usage Guide
.. toctree::
:maxdepth: 2
- :caption: Contents
intro
@@ -30,4 +29,4 @@ View Server - Usage Guide
.. only:: not builder_html
* :ref:`modindex`
- -- * :ref:`glossary`
+ .. * :ref:`glossary`
diff --git a/documentation/usage-guide/web-client.md b/documentation/usage-guide/web-client.md
deleted file mode 100644
index f7ed71a5..00000000
--- a/documentation/usage-guide/web-client.md
+++ /dev/null
@@ -1,6 +0,0 @@
-# Web Client
-
-using via GUI
-
-
-
diff --git a/documentation/usage-guide/web-client.rst b/documentation/usage-guide/web-client.rst
new file mode 100644
index 00000000..1bcdc51d
--- /dev/null
+++ b/documentation/usage-guide/web-client.rst
@@ -0,0 +1,47 @@
+Web Client
+==========
+
+The most comfortable way to exploit the functionalities of the View Server (VS)
+is via the built-in web client. This client provides an intuitively to use
+graphical user interface running in the user's web browser.
+
+.. _fig_webclient:
+.. figure:: images/webclient_start.*
+ :alt: Screenshot of View Server built-in Web Client
+
+ *View Server built-in Web Client*
+
+:numref:`fig_webclient` above shows some blub
+
+Interactive Tutorial
+--------------------
+
+.. figure:: images/webclient_tutorial_01_start.*
+ :alt: Web Client Tutorial - Start
+
+ *Web Client Tutorial - Start*
+
+.. figure:: images/webclient_tutorial_02_map.*
+ :alt: Web Client Tutorial - Map
+
+ *Web Client Tutorial - Map*
+
+.. figure:: images/webclient_tutorial_03_timeslider.*
+ :alt: Web Client Tutorial - Timeslider
+
+ *Web Client Tutorial - Timeslider*
+
+.. figure:: images/webclient_tutorial_04_search-results.*
+ :alt: Web Client Tutorial - Search Results
+
+ *Web Client Tutorial - Search Results*
+
+.. figure:: images/webclient_tutorial_05_filters.*
+ :alt: Web Client Tutorial - Filters
+
+ *Web Client Tutorial - Filters*
+
+.. figure:: images/webclient_tutorial_06_map-layers.*
+ :alt: Web Client Tutorial - Map Layers
+
+ *Web Client Tutorial - Map Layers*
--
GitLab