EOX GitLab Instance

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

More structure and first contents.

parent 75111e33
Branches
Tags
No related merge requests found
...@@ -206,7 +206,7 @@ docker exec -it $(docker ps -qf "name=emg-pvs_renderer") mv Emergency.sqlite /ca ...@@ -206,7 +206,7 @@ docker exec -it $(docker ps -qf "name=emg-pvs_renderer") mv Emergency.sqlite /ca
## Installation ## Installation
```bash ```bash
python3 -m pip install spinx recommonmark python3 -m pip install spinx recommonmark sphinx-autobuild
``` ```
## Generation ## Generation
...@@ -214,6 +214,9 @@ python3 -m pip install spinx recommonmark ...@@ -214,6 +214,9 @@ python3 -m pip install spinx recommonmark
```bash ```bash
make html make html
# For watched html automatic building
make html-watch
# For pdf output run: # For pdf output run:
make latex make latex
make latexpdf make latexpdf
......
...@@ -5,6 +5,7 @@ ...@@ -5,6 +5,7 @@
# from the environment for the first two. # from the environment for the first two.
SPHINXOPTS ?= SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build SPHINXBUILD ?= sphinx-build
SPHINXAUTOBUILD ?= sphinx-autobuild
SOURCEDIR = . SOURCEDIR = .
BUILDDIR = _build BUILDDIR = _build
...@@ -14,6 +15,9 @@ help: ...@@ -14,6 +15,9 @@ help:
.PHONY: help Makefile .PHONY: help Makefile
html-watch:
@$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# Catch-all target: route all unknown targets to Sphinx using the new # Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile %: Makefile
......
...@@ -52,12 +52,20 @@ html_theme = 'alabaster' ...@@ -52,12 +52,20 @@ html_theme = 'alabaster'
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] 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 = [( latex_documents = [(
'index', 'index',
'View-Server.tex', 'View-Server.tex',
u'View Server - Usage Guide', u'View Server - Usage Guide',
u'EOX IT Services GmbH \\and Fabian Schindler \\and Lubomir Bucek \\and \ u'EOX IT Services GmbH',
Mussab Abdalla \\and Stephan Meißl',
'manual', 'manual',
True True
)] )]
......
...@@ -5,7 +5,6 @@ View Server - Operations Guide ...@@ -5,7 +5,6 @@ View Server - Operations Guide
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents
intro intro
...@@ -25,4 +24,4 @@ View Server - Operations Guide ...@@ -25,4 +24,4 @@ View Server - Operations Guide
.. only:: not builder_html .. only:: not builder_html
* :ref:`modindex` * :ref:`modindex`
-- * :ref:`glossary` .. * :ref:`glossary`
...@@ -5,6 +5,7 @@ ...@@ -5,6 +5,7 @@
# from the environment for the first two. # from the environment for the first two.
SPHINXOPTS ?= SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build SPHINXBUILD ?= sphinx-build
SPHINXAUTOBUILD ?= sphinx-autobuild
SOURCEDIR = . SOURCEDIR = .
BUILDDIR = _build BUILDDIR = _build
...@@ -14,6 +15,9 @@ help: ...@@ -14,6 +15,9 @@ help:
.PHONY: help Makefile .PHONY: help Makefile
html-watch:
@$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# Catch-all target: route all unknown targets to Sphinx using the new # Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile %: Makefile
......
...@@ -52,12 +52,20 @@ html_theme = 'alabaster' ...@@ -52,12 +52,20 @@ html_theme = 'alabaster'
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] 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 = [( latex_documents = [(
'index', 'index',
'View-Server.tex', 'View-Server.tex',
u'View Server - Usage Guide', u'View Server - Usage Guide',
u'EOX IT Services GmbH \\and Fabian Schindler \\and Lubomir Bucek \\and \ u'EOX IT Services GmbH',
Mussab Abdalla \\and Stephan Meißl',
'manual', 'manual',
True True
)] )]
......
...@@ -5,7 +5,6 @@ View Server - Usage Guide ...@@ -5,7 +5,6 @@ View Server - Usage Guide
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents
intro intro
...@@ -30,4 +29,4 @@ View Server - Usage Guide ...@@ -30,4 +29,4 @@ View Server - Usage Guide
.. only:: not builder_html .. only:: not builder_html
* :ref:`modindex` * :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.
Please register or to comment