Skip to content

Commit

Permalink
update technical info
Browse files Browse the repository at this point in the history
  • Loading branch information
warrieka committed Apr 5, 2021
1 parent 9725f24 commit 86275bd
Show file tree
Hide file tree
Showing 59 changed files with 20,211 additions and 16 deletions.
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"python.pythonPath": "C:\\Users\\kaywa\\.conda\\envs\\qgis\\python.exe",
"python.envFile": "${workspaceFolder}/.env"
"python.envFile": "${workspaceFolder}/.env",
"restructuredtext.confPath": "${workspaceFolder}\\doc\\source"
}
9 changes: 9 additions & 0 deletions doc/source/Changelog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Changelog
=========



Version 2.7
-----------
- Refactored to make http-calls through QNetWork_ and QgsBlockingNetworkRequest_ instead of urllib.request, so QGIS proxy-settings will be used.

Version 2.6
-----------
- Production release
Expand Down Expand Up @@ -49,3 +55,6 @@ In addition to the migration to QGIS3 / Python3 / QT5, the following issues have
- AHN services work but are often slow due to the large quantity that needs to be downloaded.
- The Bathymetrie Nederland service does not work, they are not compatible with QGIS. You can not add that service via the standard method.
- Networking, reverse network proxy is used if present. The plug-in will now also work on some corporate networks with high security.

.. _QNetWork: https://doc.qt.io/qt-5/qtnetwork-index.html
.. _QgsBlockingNetworkRequest: https://qgis.github.io/pyqgis/3.16/core/QgsBlockingNetworkRequest.html
11 changes: 10 additions & 1 deletion doc/source/Modules and Classes.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Modules and Classes
===================

*Remark: the autogenerated modules ui_dataCatalog_dialog.py and ui_inspireNL_dialog.py are ommited. They are declared in de ui_inspireNL_dialog.ui and ui_inspireNL_dialog.ui and must be modified and compiled with Qtdesigner (see: http://pyqt.sourceforge.net/Docs/PyQt5/designer.html )*
*Remark: the autogenerated modules ui_dataCatalog_dialog.py and ui_inspireNL_dialog.py are ommited. They are declared in de ui_inspireNL_dialog.ui and ui_inspireNL_dialog.ui and must be modified and compiled with* Qtdesigner_.

.. _dataCatalog:

Expand Down Expand Up @@ -64,5 +64,14 @@ settings module
:undoc-members:
:show-inheritance:

.. _webUtil:

webUtil module
---------------

.. automodule:: inspireNL.webUtil
:members:
:undoc-members:
:show-inheritance:

.. _Qtdesigner: http://pyqt.sourceforge.net/Docs/PyQt5/designer.html
19 changes: 19 additions & 0 deletions doc/source/Proxy Settings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Proxy Settings
==============

Many enterprises secure their network with intermediary proxy-server the inspects external data comming into their network and then sends it through to client. In the past the plugin sometimes had problems on picking up these redirects because of the limitations of urllib library that was used until version 2.6.

Since version 2.7 of the plugin, the plugin uses the native methods of QGIS to make to http-API calls. Including calls to the Dutch INSPIRE CSW-service_. This way all the QGIS-settings are used in a identical manner, so the user must configure everything only once.

If QGIS does not automaticaly pick you enterprise Proxy. You can configure this manually. Go on the menu-bar to *Settings/Options..* :

.. image:: pic/settingsMenu.png

Then to the tab *Network*. Here can enable using proxy's and input the url and port if the system does not pick this up automaticaly:

.. image:: pic/network-settings.png

More info: Network-Settings_

.. _CSW-service: https://www.nationaalgeoregister.nl/geonetwork/srv/dut/inspire?request=GetCapabilities&service=CSW&version=2.0.2
.. _Network-Settings: https://docs.qgis.org/testing/en/docs/user_manual/introduction/qgis_configuration.html#network-settings
10 changes: 5 additions & 5 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,19 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os, sys
#sys.path.insert(0, os.path.abspath('..'))

sys.path.insert(0, r'C:\Users\sa64489\Documents\GitHub\ptvs_geopunt' )
sys.path.insert(0, r'C:\work\prj\geonovum')
sys.path.insert(0, r'C:\OSGeo4W64\apps\qgis\python' )
# -- Project information -----------------------------------------------------

project = u'The Dutch INSPIRE QGIS plugin'
copyright = u'2019, Kay Warrie'
copyright = u'2021, Geonovum, Kay Warrie'
author = u'Kay Warrie'

# The short X.Y version
version = u'2.5'
# The full version, including alpha/beta/rc tags
release = u'Version 2.5 for QGIS 3'
release = u'Version 2.7 for QGIS 3'


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -156,7 +155,8 @@
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'deNederlandseINSPIREQGISplugin', project,
author, 'deNederlandseINSPIREQGISplugin', 'One line description of project.',
author, 'deNederlandseINSPIREQGISplugin',
'One line description of project.',
'Miscellaneous'),
]

Expand Down
7 changes: 4 additions & 3 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

The Dutch INSPIRE QGIS plugin Technical Documentation
======================================================
=============================
The Dutch INSPIRE QGIS plugin
=============================

*A QGIS plugin to search and add Datasets of the Dutch Dataportal 'Nationaal Georegister' to QGIS.*

Expand All @@ -11,6 +11,7 @@ The Dutch INSPIRE QGIS plugin Technical Documentation
About
Usage
Contributing and forking
Proxy Settings
Changelog
Modules and Classes

Expand Down
Binary file added doc/source/pic/network-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/pic/settingsMenu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 376115c0a11527aab8d56755e53fc5f9
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added docs/.nojekyll
Empty file.
118 changes: 118 additions & 0 deletions docs/About.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />

<title>About &#8212; The Dutch INSPIRE QGIS plugin Version 2.7 for QGIS 3 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />

<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>

<script src="_static/sidebar.js"></script>

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Usage" href="Usage.html" />
<link rel="prev" title="The Dutch INSPIRE QGIS plugin Technical Documentation" href="index.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Usage.html" title="Usage"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="The Dutch INSPIRE QGIS plugin Technical Documentation"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">The Dutch INSPIRE QGIS plugin Version 2.7 for QGIS 3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">About</a></li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<section id="about">
<h1>About<a class="headerlink" href="#about" title="Permalink to this headline"></a></h1>
<p><em>A QGIS plugin to search and add the INSPIRE Datasets of the Dutch Dataportal ‘Nationaal Georegister’ to QGIS.</em></p>
<p><strong>About the Dutch INSPIRE QGIS plugin</strong></p>
<p>In the context of INSPIRE, the European member states are realizing a digital network for the exchange of data on the living environment. INSPIRE ensures that this geo-information is of good quality and that its content, even across national borders, is coordinated. In the Netherlands, descriptions of more than 200 INSPIRE datasets and approximately 265 associated services are now available in the National Georegister (<a class="reference external" href="http://www.nationaalgeoregister.nl/">http://www.nationaalgeoregister.nl/</a>).</p>
<p>To facilitate the use of INSPIRE data for the professional GIS users in the Netherlands, a plugin has been developed for QGIS. This plugin makes it easy to find, consult and download the INSPIRE datasets and services directly via the National Georegister. Through the plugin, a user can search INSPIRE data by keyword, INSPIRE theme, organization or type of service and add the result directly to QGIS.</p>
<p>The INSPIRE QGIS plugin was created under the responsibility of Geonovum. Geonovum supports the Ministry of the Interior and Kingdom Relations and data providers with the introduction of INSPIRE in the Netherlands. The plugin has been developed by KGIS (<a class="reference external" href="http://kgis.be/">http://kgis.be/</a>).</p>
<p>If you have any questions about INSPIRE or the plugin, please visit <a class="reference external" href="https://www.geonovum.nl/geo-standaarden/inspire-europese-leefomgeving">https://www.geonovum.nl/geo-standaarden/inspire-europese-leefomgeving</a> or submit them to the INSPIRE helpdesk (<a class="reference external" href="mailto:inspire&#37;&#52;&#48;geonovum&#46;nl">inspire<span>&#64;</span>geonovum<span>&#46;</span>nl</a>).</p>
</section>


<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">The Dutch INSPIRE QGIS plugin Technical Documentation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Usage.html"
title="next chapter">Usage</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/About.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Usage.html" title="Usage"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="The Dutch INSPIRE QGIS plugin Technical Documentation"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">The Dutch INSPIRE QGIS plugin Version 2.7 for QGIS 3 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">About</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2021, Geonovum, Kay Warrie.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.3.
</div>
</body>
</html>
Loading

0 comments on commit 86275bd

Please sign in to comment.