EOX GitLab Instance

Skip to content
Snippets Groups Projects
Verified Commit c8e85c04 authored by Stephan's avatar Stephan
Browse files

More structure and first contents.

parent 40feb860
No related branches found
No related tags found
1 merge request!8Docs
Showing
with 81 additions and 15 deletions
......@@ -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
......
......@@ -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
......
......@@ -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
)]
......
......@@ -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`
......@@ -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
......
......@@ -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
)]
......
documentation/usage-guide/images/client_start.png

2.07 MiB

documentation/usage-guide/images/webclient_start.png

2.25 MiB

documentation/usage-guide/images/webclient_tutorial_01_start.png

2.33 MiB

documentation/usage-guide/images/webclient_tutorial_02_map.png

2.29 MiB

documentation/usage-guide/images/webclient_tutorial_03_timeslider.png

1.48 MiB

documentation/usage-guide/images/webclient_tutorial_04_search-results.png

1.59 MiB

documentation/usage-guide/images/webclient_tutorial_05_filters.png

1.38 MiB

documentation/usage-guide/images/webclient_tutorial_06_map-layers.png

1.41 MiB

......@@ -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`
# Web Client
using via GUI
![Web Client at Start](images/client_start.* "Web Client at Start")
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*
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment