Skip to content

Commit

Permalink
workaround for substitutions
Browse files Browse the repository at this point in the history
  • Loading branch information
landam committed Jul 11, 2017
1 parent a9f27a7 commit 5dc1891
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 21 deletions.
18 changes: 18 additions & 0 deletions docs/.substitutions1
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. |tip| image:: ./img/paragraphs/tip.png
:width: 2.5em
.. |att| image:: ./img/paragraphs/attention.png
:width: 2.5em
.. |todo| image:: ./img/paragraphs/todo.png
:width: 1.5em
.. |see| image:: ./img/paragraphs/see.png
:width: 1.5em
.. |note| image:: ./img/paragraphs/note.png
:width: 1.5em
.. |imp| image:: ./img/paragraphs/important.png
:width: 1.5em
.. |danger| image:: ./img/paragraphs/danger.png
:width: 1.5em
.. |problem| image:: ./img/paragraphs/problem.png
:width: 1em
.. |solution| image:: ./img/paragraphs/solution.png
:width: 1em
File renamed without changes.
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@
#keep_warnings = False

rst_epilog = """
.. include:: ../.substitutions
.. include:: .substitutions1
.. include:: ../.substitutions2
"""

# -- Options for HTML output ----------------------------------------------
Expand Down
22 changes: 7 additions & 15 deletions docs/datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,17 @@ by GIS.lab developers and later adopted by Gisquick project. Later,
the second dataset :ref:`dataset-prague` was developed for specific
needs of Gisquick publishing platform.

Sample datasets are available from ``gisquick-sample-projects`` Git
repository:

.. code-block:: bash
git clone https://github.com/gislab-npo/gisquick-sample-projects
.. important:: |imp| Large data files are stored `Git Large File
Storage <https://git-lfs.github.com/>`__. Therefore Git LFS extension
must be installed.

.. _dataset-natural-earth:

=============
Natural earth
=============

Database ``natural-earth.sqlite``. Available online at
https://github.com/gislab-npo/gisquick-sample-projects/tree/master/natural-earth.
Database ``natural-earth.sqlite``. Available online from `GitHub
repository
<https://github.com/gislab-npo/gisquick/tree/master/qgis/project/natural-earth>`__
or directly as `zip file
<http://training.gismentors.eu/geodata/gisquick/natural-earth.tar.gz>`__.

.. rubric:: Data source

Expand Down Expand Up @@ -140,8 +132,8 @@ data and other information (urban landscape)
Prague
======

Database ``prague.sqlite``. Available online at
https://github.com/gislab-npo/gisquick-sample-projects/tree/master/prague.
Database ``prague.sqlite``. Downloadable as `zip file
<http://training.gismentors.eu/geodata/gisquick/prague.tar.gz>`__.

.. rubric:: Data source

Expand Down
23 changes: 18 additions & 5 deletions docs/project-publishing.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. |plugin| image:: ./img/logo.png
:width: 2.5em

.. _project-publishing:

==================
Expand All @@ -19,17 +22,27 @@ Services (WMS, WFS, WCS).

Before publishing using Gisquick plugin, the project must be saved.

.. note:: When using flat files or file-based databases as data stores
it is recommended to save all the files (data and QGIS project) in
the same directory. QGIS project must be set up to use **relative**
paths (see *Project Properties*).
.. important:: |imp| When using flat files or file-based databases as
data stores it is recommended to save all the files (data and QGIS
project) in the same directory. QGIS project must be set up to use
**relative** paths (see *Project Properties*).

When using any kind of authentatization (databases, web services)
it must be ensured that server used for publishing will have access
to such data sources.

Publishing QGIS project will be demostrated on :ref:`Prague sample
project <dataset-prague>`.
project <dataset-prague>`. At first, sample :file:`prague.qgs` QGIS
project will be open in QGIS Desktop. Before doing any changes we try
to publish the project as it is.

.. figure:: ./img/qgis-prague.png

Prague sample project loaded in QGIS.

Publication process is started by Gisquick QGIS plugin
|plugin|. Plugin is designed as simple wizard which helps simplifying
publishing process as much as possible.

When ``Publish`` button is successfully pressed in GIS.lab QGIS plugin
:ref:`dialog <gisquick-qgis-plugin-publish>`,
Expand Down

0 comments on commit 5dc1891

Please sign in to comment.