mirror of
https://github.com/qgis/QGIS.git
synced 2025-12-15 00:07:25 -05:00
Fix inconsistent heading warnings when building PyQGIS docs
Fixes missing subclass/base class sections in some class docs ( eg QgsVectorLayer)
This commit is contained in:
Nyall Dawson
parent
7996e1b587
commit
161ef62ca0
@ -36,7 +36,7 @@ Usage:
|
||||
# examine the result
|
||||
|
||||
Three Value Logic
|
||||
-----------------
|
||||
=================
|
||||
|
||||
Similarly to SQL, this class supports three-value logic:
|
||||
true/false/unknown. Unknown value may be a result of operations with
|
||||
@ -48,14 +48,14 @@ represented as 1/0 integer, unknown value is represented the same way as
|
||||
NULL values: NULL QVariant.
|
||||
|
||||
Performance
|
||||
-----------
|
||||
===========
|
||||
|
||||
For better performance with many evaluations you may first call
|
||||
prepare(fields) function to find out indices of columns and then
|
||||
repeatedly call evaluate(feature).
|
||||
|
||||
Type conversion
|
||||
---------------
|
||||
===============
|
||||
|
||||
Operators and functions that expect arguments to be of a particular type
|
||||
automatically convert the arguments to that type, e.g. sin('2.1') will
|
||||
@ -67,7 +67,7 @@ numeric comparison in case both operators are numeric (int/double) or
|
||||
they can be converted to numeric types.
|
||||
|
||||
Implicit sharing
|
||||
----------------
|
||||
================
|
||||
|
||||
This class is implicitly shared, copying has a very low overhead. It is
|
||||
normally preferable to call `QgsExpression( otherExpression )` instead
|
||||
|
||||
@ -30,10 +30,10 @@ different data types. It does not yet support editing transactions.
|
||||
The main data providers supported by QGIS are listed below.
|
||||
|
||||
Mesh data providers
|
||||
-------------------
|
||||
===================
|
||||
|
||||
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
|
||||
@ -56,7 +56,7 @@ to create mesh with one quad and one triangle
|
||||
scratchLayer = QgsMeshLayer(uri, "My Scratch layer", "mesh_memory")
|
||||
|
||||
MDAL data provider (mdal)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
-------------------------
|
||||
|
||||
Accesses data using the MDAL drivers
|
||||
(https://github.com/lutraconsulting/MDAL). The url is the MDAL
|
||||
|
||||
@ -70,7 +70,7 @@ This will produce the following output:
|
||||
CRS PROJ text: +proj=tmerc +lat_0=49 +lon_0=-2 +k=0.9996012717 +x_0=400000 +y_0=-100000 [output trimmed]
|
||||
|
||||
CRS Definition Formats
|
||||
----------------------
|
||||
======================
|
||||
|
||||
This section gives an overview of various supported CRS definition
|
||||
formats:
|
||||
@ -127,7 +127,7 @@ machines or user profiles.
|
||||
.. seealso:: :py:func:`createFromWkt`
|
||||
|
||||
CRS Database and Custom CRS
|
||||
---------------------------
|
||||
===========================
|
||||
|
||||
The database of CRS shipped with QGIS is stored in a SQLite database
|
||||
(see :py:func:`QgsApplication.srsDatabaseFilePath()`) and it is based on
|
||||
@ -151,7 +151,7 @@ be accessed directly with SQLite functions, instead you should use
|
||||
managements of custom CRS.
|
||||
|
||||
Validation
|
||||
----------
|
||||
==========
|
||||
|
||||
In some cases (most prominently when loading a map layer), QGIS will try
|
||||
to ensure that the given map layer CRS is valid using
|
||||
@ -164,7 +164,7 @@ registers its validation function that will act according to user's
|
||||
settings (either show CRS selector dialog or use project/custom CRS).
|
||||
|
||||
Object Construction and Copying
|
||||
-------------------------------
|
||||
===============================
|
||||
|
||||
The easiest way of creating CRS instances is to use
|
||||
QgsCoordinateReferenceSystem(const QString&) constructor that
|
||||
@ -181,7 +181,7 @@ Since QGIS 2.16 :py:class:`QgsCoordinateReferenceSystem` objects are
|
||||
implicitly shared.
|
||||
|
||||
Caveats
|
||||
-------
|
||||
=======
|
||||
|
||||
There are two different flavors of WKT: one is defined by OGC, the other
|
||||
is the standard used by ESRI. They look very similar, but they are not
|
||||
|
||||
@ -52,10 +52,10 @@ Sample usage of the :py:class:`QgsVectorLayer` class:
|
||||
The main data providers supported by QGIS are listed below.
|
||||
|
||||
Vector data providers
|
||||
---------------------
|
||||
=====================
|
||||
|
||||
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
|
||||
@ -87,7 +87,7 @@ possible to suppress that by setting the following custom variable:
|
||||
layer.setCustomProperty("skipMemoryLayersCheck", 1)
|
||||
|
||||
OGR data provider (ogr)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
-----------------------
|
||||
|
||||
Accesses data using the OGR drivers
|
||||
(https://gdal.org/drivers/vector/index.html). The url is the OGR
|
||||
@ -97,28 +97,28 @@ database formats, and web services. Some of these formats are also
|
||||
supported by custom data providers listed below.
|
||||
|
||||
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 :py:class:`QgsDataSourceUri` class.
|
||||
|
||||
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 :py:class:`QgsDataSourceUri` class.
|
||||
|
||||
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 :py:class:`QgsDataSourceUri` class.
|
||||
|
||||
WFS (web feature service) data provider (wfs)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
---------------------------------------------
|
||||
|
||||
Used to access data provided by a web feature service.
|
||||
|
||||
@ -168,7 +168,7 @@ Also note:
|
||||
``intersects(@geometry, geomFromWKT('POINT (5 6)'))``
|
||||
|
||||
OGC API Features data provider (oapif)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
--------------------------------------
|
||||
|
||||
Used to access data provided by a OGC API - Features server.
|
||||
|
||||
@ -190,7 +190,7 @@ class with the following parameters:
|
||||
- hideDownloadProgressDialog=1: to hide the download progress dialog.
|
||||
|
||||
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
|
||||
@ -342,7 +342,7 @@ dialog if quiet is included (They will still be shown in the output
|
||||
log).
|
||||
|
||||
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
|
||||
@ -351,7 +351,7 @@ defines the name of the file, and the type of data to retrieve from it
|
||||
An example url is "/home/user/data/holiday.gpx?type=route"
|
||||
|
||||
Grass data provider (grass)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
---------------------------
|
||||
|
||||
Provider to display vector data in a GRASS GIS layer.
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ Usage:
|
||||
# examine the result
|
||||
|
||||
Three Value Logic
|
||||
-----------------
|
||||
=================
|
||||
|
||||
Similarly to SQL, this class supports three-value logic:
|
||||
true/false/unknown. Unknown value may be a result of operations with
|
||||
@ -48,14 +48,14 @@ represented as 1/0 integer, unknown value is represented the same way as
|
||||
NULL values: NULL QVariant.
|
||||
|
||||
Performance
|
||||
-----------
|
||||
===========
|
||||
|
||||
For better performance with many evaluations you may first call
|
||||
prepare(fields) function to find out indices of columns and then
|
||||
repeatedly call evaluate(feature).
|
||||
|
||||
Type conversion
|
||||
---------------
|
||||
===============
|
||||
|
||||
Operators and functions that expect arguments to be of a particular type
|
||||
automatically convert the arguments to that type, e.g. sin('2.1') will
|
||||
@ -67,7 +67,7 @@ numeric comparison in case both operators are numeric (int/double) or
|
||||
they can be converted to numeric types.
|
||||
|
||||
Implicit sharing
|
||||
----------------
|
||||
================
|
||||
|
||||
This class is implicitly shared, copying has a very low overhead. It is
|
||||
normally preferable to call `QgsExpression( otherExpression )` instead
|
||||
|
||||
@ -30,10 +30,10 @@ different data types. It does not yet support editing transactions.
|
||||
The main data providers supported by QGIS are listed below.
|
||||
|
||||
Mesh data providers
|
||||
-------------------
|
||||
===================
|
||||
|
||||
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
|
||||
@ -56,7 +56,7 @@ to create mesh with one quad and one triangle
|
||||
scratchLayer = QgsMeshLayer(uri, "My Scratch layer", "mesh_memory")
|
||||
|
||||
MDAL data provider (mdal)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
-------------------------
|
||||
|
||||
Accesses data using the MDAL drivers
|
||||
(https://github.com/lutraconsulting/MDAL). The url is the MDAL
|
||||
|
||||
@ -70,7 +70,7 @@ This will produce the following output:
|
||||
CRS PROJ text: +proj=tmerc +lat_0=49 +lon_0=-2 +k=0.9996012717 +x_0=400000 +y_0=-100000 [output trimmed]
|
||||
|
||||
CRS Definition Formats
|
||||
----------------------
|
||||
======================
|
||||
|
||||
This section gives an overview of various supported CRS definition
|
||||
formats:
|
||||
@ -127,7 +127,7 @@ machines or user profiles.
|
||||
.. seealso:: :py:func:`createFromWkt`
|
||||
|
||||
CRS Database and Custom CRS
|
||||
---------------------------
|
||||
===========================
|
||||
|
||||
The database of CRS shipped with QGIS is stored in a SQLite database
|
||||
(see :py:func:`QgsApplication.srsDatabaseFilePath()`) and it is based on
|
||||
@ -151,7 +151,7 @@ be accessed directly with SQLite functions, instead you should use
|
||||
managements of custom CRS.
|
||||
|
||||
Validation
|
||||
----------
|
||||
==========
|
||||
|
||||
In some cases (most prominently when loading a map layer), QGIS will try
|
||||
to ensure that the given map layer CRS is valid using
|
||||
@ -164,7 +164,7 @@ registers its validation function that will act according to user's
|
||||
settings (either show CRS selector dialog or use project/custom CRS).
|
||||
|
||||
Object Construction and Copying
|
||||
-------------------------------
|
||||
===============================
|
||||
|
||||
The easiest way of creating CRS instances is to use
|
||||
QgsCoordinateReferenceSystem(const QString&) constructor that
|
||||
@ -181,7 +181,7 @@ Since QGIS 2.16 :py:class:`QgsCoordinateReferenceSystem` objects are
|
||||
implicitly shared.
|
||||
|
||||
Caveats
|
||||
-------
|
||||
=======
|
||||
|
||||
There are two different flavors of WKT: one is defined by OGC, the other
|
||||
is the standard used by ESRI. They look very similar, but they are not
|
||||
|
||||
@ -52,10 +52,10 @@ Sample usage of the :py:class:`QgsVectorLayer` class:
|
||||
The main data providers supported by QGIS are listed below.
|
||||
|
||||
Vector data providers
|
||||
---------------------
|
||||
=====================
|
||||
|
||||
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
|
||||
@ -87,7 +87,7 @@ possible to suppress that by setting the following custom variable:
|
||||
layer.setCustomProperty("skipMemoryLayersCheck", 1)
|
||||
|
||||
OGR data provider (ogr)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
-----------------------
|
||||
|
||||
Accesses data using the OGR drivers
|
||||
(https://gdal.org/drivers/vector/index.html). The url is the OGR
|
||||
@ -97,28 +97,28 @@ database formats, and web services. Some of these formats are also
|
||||
supported by custom data providers listed below.
|
||||
|
||||
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 :py:class:`QgsDataSourceUri` class.
|
||||
|
||||
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 :py:class:`QgsDataSourceUri` class.
|
||||
|
||||
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 :py:class:`QgsDataSourceUri` class.
|
||||
|
||||
WFS (web feature service) data provider (wfs)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
---------------------------------------------
|
||||
|
||||
Used to access data provided by a web feature service.
|
||||
|
||||
@ -168,7 +168,7 @@ Also note:
|
||||
``intersects(@geometry, geomFromWKT('POINT (5 6)'))``
|
||||
|
||||
OGC API Features data provider (oapif)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
--------------------------------------
|
||||
|
||||
Used to access data provided by a OGC API - Features server.
|
||||
|
||||
@ -190,7 +190,7 @@ class with the following parameters:
|
||||
- hideDownloadProgressDialog=1: to hide the download progress dialog.
|
||||
|
||||
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
|
||||
@ -342,7 +342,7 @@ dialog if quiet is included (They will still be shown in the output
|
||||
log).
|
||||
|
||||
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
|
||||
@ -351,7 +351,7 @@ defines the name of the file, and the type of data to retrieve from it
|
||||
An example url is "/home/user/data/holiday.gpx?type=route"
|
||||
|
||||
Grass data provider (grass)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
---------------------------
|
||||
|
||||
Provider to display vector data in a GRASS GIS layer.
|
||||
|
||||
|
||||
@ -821,7 +821,7 @@ def process_doxygen_line(line: str) -> str:
|
||||
# Handle section and subsection
|
||||
section_match = re.match(r"^\\(?P<SUB>sub)?section", line)
|
||||
if section_match:
|
||||
sep = "^" if section_match.group("SUB") else "-"
|
||||
sep = "-" if section_match.group("SUB") else "="
|
||||
line = re.sub(r"^\\(sub)?section \w+ ", "", line)
|
||||
sep_line = re.sub(r"[\w ()]", sep, line)
|
||||
line += f"\n{sep_line}"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user