Skip to content
Permalink
Browse files

[sipify] format section/subsection to RST

  • Loading branch information
github-actions committed Jul 9, 2020
1 parent 6f859c5 commit 47e7f1ee2d794dd3e3b2b8a512d8e052ea23ddb9
@@ -28,9 +28,11 @@ yet support editing transactions.

The main data providers supported by QGIS are listed below.

\section mesh_providers Mesh data providers
Mesh data providers
-------------------

\subsection mesh_memory Memory data providerType (mesh_memory)
Memory data providerType (mesh_memory)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The memory data provider is used to construct in memory data, for example scratch
data. There is no inherent persistent storage of the data. The data source uri is constructed.
@@ -52,7 +54,8 @@ E.g. to create mesh with one quad and one triangle
);
QgsMeshLayer *scratchLayer = new QgsMeshLayer(uri, "My Scratch layer", "memory_mesh");

\subsection mdal MDAL data provider (mdal)
MDAL data provider (mdal)
~~~~~~~~~~~~~~~~~~~~~~~~~

Accesses data using the MDAL drivers (https://github.com/lutraconsulting/MDAL). The url
is the MDAL connection string. QGIS must be built with MDAL support to allow this provider.
@@ -41,9 +41,11 @@ Sample usage of the QgsVectorLayer class:

The main data providers supported by QGIS are listed below.

\section providers Vector data providers
Vector data providers
---------------------

\subsection memory Memory data providerType (memory)
Memory data providerType (memory)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The memory data provider is used to construct in memory data, for example scratch
data or data generated from spatial operations such as contouring. There is no
@@ -72,33 +74,38 @@ trigger such warning, it is possible to suppress that by setting the following c

layer.setCustomProperty("skipMemoryLayersCheck", 1)

\subsection ogr OGR data provider (ogr)
OGR data provider (ogr)
~~~~~~~~~~~~~~~~~~~~~~~

Accesses data using the OGR drivers (http://www.gdal.org/ogr/ogr_formats.html). The url
is the OGR connection string. A wide variety of data formats can be accessed using this
driver, including file based formats used by many GIS systems, database formats, and
web services. Some of these formats are also supported by custom data providers listed
below.

\subsection spatialite SpatiaLite data provider (spatialite)
SpatiaLite data provider (spatialite)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Access data in a SpatiaLite database. The url defines the connection parameters, table,
geometry column, and other attributes. The url can be constructed using the
QgsDataSourceUri class.

\subsection postgres PostgreSQL data provider (postgres)
PostgreSQL data provider (postgres)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Connects to a PostgreSQL database. The url defines the connection parameters, table,
geometry column, and other attributes. The url can be constructed using the
QgsDataSourceUri class.

\subsection mssql Microsoft SQL server data provider (mssql)
Microsoft SQL server data provider (mssql)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Connects to a Microsoft SQL server database. The url defines the connection parameters, table,
geometry column, and other attributes. The url can be constructed using the
QgsDataSourceUri class.

\subsection wfs WFS (web feature service) data provider (wfs)
WFS (web feature service) data provider (wfs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Used to access data provided by a web feature service.

@@ -129,6 +136,28 @@ attribute operators, “BBOX, Disjoint, Intersects, Touches, Crosses, Contains,
spatial binary operators and the QGIS local “geomFromWKT, geomFromGML”
geometry constructor functions.

<<<<<<< HEAD
=======
OGC API - Features data provider (oapif)
~~~~~~~~-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Used to access data provided by a OGC API - Features server.

The URI should be constructed using the QgsDataSourceUri class with the following parameters:

- url=string (mandatory): HTTP url to a OGC API - Features landing page.
- typename=string (mandatory): Collection id
- username=string
- password=string
- authcfg=string
- filter=string: QGIS expression (only datetime filtering is forwarded to the server)
- restrictToRequestBBOX=1: to download only features in the view extent (or more generally
in the bounding box of the feature iterator)
- pageSize=number: number of features to retrieve in a single request
- maxNumFeatures=number: maximum number of features to retrieve (possibly across several multiple paging requests)
- hideDownloadProgressDialog=1: to hide the download progress dialog.

>>>>>>> d76fe84051... Merge pull request #37713 from 3nids/pyqgis-doc-sectionizer
Also note:

- You can use various functions available in the QGIS Expression list,
@@ -137,7 +166,8 @@ however the function must exist server side and have the same name and arguments
- Use the special $geometry parameter to provide the layer geometry column as input
into the spatial binary operators e.g intersects($geometry, geomFromWKT('POINT (5 6)'))

\subsection delimitedtext Delimited text file data provider (delimitedtext)
Delimited text file data provider (delimitedtext)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Accesses data in a delimited text file, for example CSV files generated by
spreadsheets. The contents of the file are split into columns based on specified
@@ -284,15 +314,17 @@ to monitor for changes.
Errors encountered loading the file will not be reported in a user dialog if
quiet is included (They will still be shown in the output log).

\subsection gpx GPX data provider (gpx)
GPX data provider (gpx)
~~~~~~~~~~~~~~~~~~~~~~~

Provider reads tracks, routes, and waypoints from a GPX file. The url
defines the name of the file, and the type of data to retrieve from it
("track", "route", or "waypoint").

An example url is "/home/user/data/holiday.gpx?type=route"

\subsection grass Grass data provider (grass)
Grass data provider (grass)
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Provider to display vector data in a GRASS GIS layer.

@@ -184,6 +184,25 @@ sub processDoxygenLine {
# replace nullptr with None (nullptr means nothing to Python devs)
$line =~ s/\bnullptr\b/None/g;

<<<<<<< HEAD
=======
if ( $line =~ m/^\\(?<SUB>sub)?section/) {
my $sep = "-";
$sep = "~" if defined $+{SUB};
$line =~ s/^\\(sub)?section \w+ //;
my $sep_line = $line =~ s/[\w ()]/$sep/gr;
$line .= "\n".$sep_line;
}
# convert ### style headings
if ( $line =~ m/^###\s+(.*)$/) {
$line = "$1\n".('-' x length($1));
}
if ( $line =~ m/^##\s+(.*)$/) {
$line = "$1\n".('=' x length($1));
}
>>>>>>> d76fe84051... Merge pull request #37713 from 3nids/pyqgis-doc-sectionizer
if ( $line eq '*' ) {
$line = '';
}

0 comments on commit 47e7f1e

Please sign in to comment.
You can’t perform that action at this time.