Skip to content

Commit 50c7692

Browse files
nyalldawsonnyalldawson
committedMar 31, 2023
Followup 30700f1, ensure links to Qgis members are set in docstrings
·
ltr-3_40final-3_32_0
1 parent 73fea28 commit 50c7692

39 files changed

+119
-119
lines changed
 

‎githubprivate.key

495 Bytes
Binary file not shown.

‎python/core/auto_generated/browser/qgsdirectoryitem.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Check if the given path is hidden from the browser model
123123
Returns the monitoring setting for a directory ``path``.
124124

125125
This method returns the monitoring setting for ``path`` only. If no explicit monitoring setting
126-
is in place for the path then Qgis.BrowserDirectoryMonitoring.Default is returned.
126+
is in place for the path then :py:class:`Qgis`.BrowserDirectoryMonitoring.Default is returned.
127127

128128
This method does not consider the monitoring setting of parent directories.
129129

‎python/core/auto_generated/externalstorage/qgsexternalstorage.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Returns a :py:class:`QgsExternalStorageStoredContent` to follow the status of th
4545

4646
``storingMode`` defines if the download will start immediately or shall be manually triggered
4747
calling :py:func:`QgsExternalStorageStoredContent.store()`. User should use
48-
Qgis.ActionStart.Deferred if he needs to connect the :py:func:`~QgsExternalStorage.stored` signal.
48+
:py:class:`Qgis`.ActionStart.Deferred if he needs to connect the :py:func:`~QgsExternalStorage.stored` signal.
4949

5050
After using this method, user wait for :py:func:`QgsExternalStorageStoredContent.stored()`,
5151
:py:func:`QgsExternalStorageStoredContent.errorOccurred()` or :py:func:`QgsExternalStorageStoredContent.canceled()` signals.
@@ -63,7 +63,7 @@ Returns a :py:class:`QgsExternalStorageFetchedContent` to follow the status of t
6363

6464
``fetchingMode`` defines if the download will start immediately or shall be manually triggered
6565
calling :py:func:`QgsExternalStorageFetchedContent.fetch()`. User should use
66-
Qgis.ActionStart.Deferred if he needs to connect the :py:func:`~QgsExternalStorage.fetched` signal.
66+
:py:class:`Qgis`.ActionStart.Deferred if he needs to connect the :py:func:`~QgsExternalStorage.fetched` signal.
6767

6868
After using this method, user should wait for :py:func:`QgsExternalStorageStoredContent.fetched()`,
6969
:py:func:`QgsExternalStorageStoredContent.errorOccurred()` or :py:func:`QgsExternalStorageStoredContent.canceled()` signals.

‎python/core/auto_generated/geometry/qgsabstractgeometry.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -749,7 +749,7 @@ This method returns a reference only, and does not involve any geometry cloning.
749749
Checks validity of the geometry, and returns ``True`` if the geometry is valid.
750750

751751
:param flags: indicates optional flags which control the type of validity checking performed
752-
(corresponding to Qgis.GeometryValidityFlags).
752+
(corresponding to :py:class:`Qgis`.GeometryValidityFlags).
753753

754754
:return: - ``True`` if geometry is valid
755755
- error: will be set to the validity error message

‎python/core/auto_generated/geometry/qgsgeometry.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,7 @@ Returns type of the geometry as a WKB type (point / linestring / polygon etc.)
307307

308308
Qgis::GeometryType type() const /HoldGIL/;
309309
%Docstring
310-
Returns type of the geometry as a Qgis.GeometryType
310+
Returns type of the geometry as a :py:class:`Qgis`.GeometryType
311311

312312
.. seealso:: :py:func:`wkbType`
313313
%End

‎python/core/auto_generated/geometry/qgswkbtypes.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ Invalid geometry types will return a dimension of 0.
191191
%Docstring
192192
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a
193193
PolygonGeometry geometry type.
194-
GeometryCollections are reported as Qgis.GeometryType.Unknown.
194+
GeometryCollections are reported as :py:class:`Qgis`.GeometryType.Unknown.
195195
%End
196196

197197
static QString displayString( Qgis::WkbType type ) /HoldGIL/;

‎python/core/auto_generated/gps/qgsvectorlayergpslogger.sip.in

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -102,27 +102,27 @@ Depending on the ``component``, the field will either refer to the :py:func:`~Qg
102102

103103
Fields stored in the :py:func:`~QgsVectorLayerGpsLogger.pointsLayer` are:
104104

105-
- Qgis.GpsInformationComponent.Location:
106-
- Qgis.GpsInformationComponent.Altitude:
107-
- Qgis.GpsInformationComponent.GroundSpeed:
108-
- Qgis.GpsInformationComponent.Bearing:
109-
- Qgis.GpsInformationComponent.Pdop:
110-
- Qgis.GpsInformationComponent.Hdop:
111-
- Qgis.GpsInformationComponent.Vdop:
112-
- Qgis.GpsInformationComponent.HorizontalAccuracy:
113-
- Qgis.GpsInformationComponent.VerticalAccuracy:
114-
- Qgis.GpsInformationComponent.HvAccuracy:
115-
- Qgis.GpsInformationComponent.SatellitesUsed:
116-
- Qgis.GpsInformationComponent.Timestamp:
117-
- Qgis.GpsInformationComponent.TrackDistanceSinceLastPoint:
118-
- Qgis.GpsInformationComponent.TrackTimeSinceLastPoint:
105+
- :py:class:`Qgis`.GpsInformationComponent.Location:
106+
- :py:class:`Qgis`.GpsInformationComponent.Altitude:
107+
- :py:class:`Qgis`.GpsInformationComponent.GroundSpeed:
108+
- :py:class:`Qgis`.GpsInformationComponent.Bearing:
109+
- :py:class:`Qgis`.GpsInformationComponent.Pdop:
110+
- :py:class:`Qgis`.GpsInformationComponent.Hdop:
111+
- :py:class:`Qgis`.GpsInformationComponent.Vdop:
112+
- :py:class:`Qgis`.GpsInformationComponent.HorizontalAccuracy:
113+
- :py:class:`Qgis`.GpsInformationComponent.VerticalAccuracy:
114+
- :py:class:`Qgis`.GpsInformationComponent.HvAccuracy:
115+
- :py:class:`Qgis`.GpsInformationComponent.SatellitesUsed:
116+
- :py:class:`Qgis`.GpsInformationComponent.Timestamp:
117+
- :py:class:`Qgis`.GpsInformationComponent.TrackDistanceSinceLastPoint:
118+
- :py:class:`Qgis`.GpsInformationComponent.TrackTimeSinceLastPoint:
119119

120120
Fields stored in the :py:func:`~QgsVectorLayerGpsLogger.tracksLayer` are:
121121

122-
- Qgis.GpsInformationComponent.TrackStartTime:
123-
- Qgis.GpsInformationComponent.TrackEndTime:
124-
- Qgis.GpsInformationComponent.TotalTrackLength:
125-
- Qgis.GpsInformationComponent.TrackDistanceFromStart:
122+
- :py:class:`Qgis`.GpsInformationComponent.TrackStartTime:
123+
- :py:class:`Qgis`.GpsInformationComponent.TrackEndTime:
124+
- :py:class:`Qgis`.GpsInformationComponent.TotalTrackLength:
125+
- :py:class:`Qgis`.GpsInformationComponent.TrackDistanceFromStart:
126126

127127
.. seealso:: :py:func:`destinationField`
128128
%End

‎python/core/auto_generated/processing/qgsprocessingparameters.sip.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1848,7 +1848,7 @@ A geometry parameter for processing algorithms.
18481848
%Docstring
18491849
Constructor for QgsProcessingParameterGeometry.
18501850

1851-
The ``geometryTypes`` argument allows for specifying a list of geometry types (see Qgis.GeometryType) acceptable for this
1851+
The ``geometryTypes`` argument allows for specifying a list of geometry types (see :py:class:`Qgis`.GeometryType) acceptable for this
18521852
parameter. Passing a empty list will allow for any type of geometry.
18531853
The ``allowMultiPart`` argument allows specifying a multi part geometry
18541854
%End
@@ -1875,14 +1875,14 @@ Returns the type name for the parameter class.
18751875

18761876
QList<int> geometryTypes() const;
18771877
%Docstring
1878-
Returns the parameter allowed geometries, as a list of Qgis.GeometryType values.
1878+
Returns the parameter allowed geometries, as a list of :py:class:`Qgis`.GeometryType values.
18791879

18801880
.. seealso:: :py:func:`setGeometryTypes`
18811881
%End
18821882

18831883
void setGeometryTypes( const QList<int> &geometryTypes );
18841884
%Docstring
1885-
Sets the allowed ``geometryTypes``, as a list of Qgis.GeometryType values.
1885+
Sets the allowed ``geometryTypes``, as a list of :py:class:`Qgis`.GeometryType values.
18861886

18871887
.. seealso:: :py:func:`geometryTypes`
18881888
%End

‎python/core/auto_generated/proj/qgscoordinatereferencesystemutils.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Returns the default coordinate order to use for the specified ``crs``.
2929
.. warning::
3030

3131
This is quite a "coarse" method, in that many possible CRS axis don't map well to a simply X/Y or Y/X order.
32-
Accordingly this method will default to returning Qgis.CoordinateOrder.XY unless we are reasonably certain of a Y/X order.
32+
Accordingly this method will default to returning :py:class:`Qgis`.CoordinateOrder.XY unless we are reasonably certain of a Y/X order.
3333
%End
3434

3535
static QString axisDirectionToAbbreviatedString( Qgis::CrsAxisDirection axis );

‎python/core/auto_generated/project/qgsproject.sip.in

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -976,15 +976,15 @@ Returns the edit buffer group
976976
Should default values be evaluated on provider side when requested and not when committed.
977977

978978
.. deprecated::
979-
Test whether the :py:func:`~QgsProject.flags` method returns the Qgis.ProjectFlag.EvaluateDefaultValuesOnProviderSide flag instead.
979+
Test whether the :py:func:`~QgsProject.flags` method returns the :py:class:`Qgis`.ProjectFlag.EvaluateDefaultValuesOnProviderSide flag instead.
980980
%End
981981

982982
void setEvaluateDefaultValues( bool evaluateDefaultValues ) /Deprecated/;
983983
%Docstring
984984
Defines if default values should be evaluated on provider side when requested and not when committed.
985985

986986
.. deprecated::
987-
use setFlag( Qgis.ProjectFlag.EvaluateDefaultValuesOnProviderSide ) instead.
987+
use setFlag( :py:class:`Qgis`.ProjectFlag.EvaluateDefaultValuesOnProviderSide ) instead.
988988
%End
989989

990990
virtual QgsExpressionContext createExpressionContext() const;
@@ -1348,7 +1348,7 @@ materialized views with Postgres provider.
13481348
:param trust: ``True`` to trust the project, ``False`` otherwise
13491349

13501350
.. deprecated::
1351-
Use setFlag( Qgis.ProjectFlag.TrustStoredLayerStatistics ) instead.
1351+
Use setFlag( :py:class:`Qgis`.ProjectFlag.TrustStoredLayerStatistics ) instead.
13521352
%End
13531353

13541354
bool trustLayerMetadata() const /Deprecated/;
@@ -1361,7 +1361,7 @@ unicity is not checked for views and materialized views with Postgres
13611361
provider.
13621362

13631363
.. deprecated::
1364-
Test whether the :py:func:`~QgsProject.flags` method returns the Qgis.ProjectFlag.TrustStoredLayerStatistics flag instead.
1364+
Test whether the :py:func:`~QgsProject.flags` method returns the :py:class:`Qgis`.ProjectFlag.TrustStoredLayerStatistics flag instead.
13651365
%End
13661366

13671367

@@ -1728,7 +1728,7 @@ Emitted when a layer is loaded
17281728
Emitted when loading layers has produced some messages
17291729

17301730
:param layerName: the layer name
1731-
:param messages: a list of pairs of Qgis.MessageLevel and messages
1731+
:param messages: a list of pairs of :py:class:`Qgis`.MessageLevel and messages
17321732

17331733
.. versionadded:: 3.2
17341734
%End

‎python/core/auto_generated/project/qgsprojectdisplaysettings.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Sets the default coordinate axis ``order`` to use when displaying coordinates fo
120120

121121
QgsCoordinateReferenceSystem coordinateCustomCrs() const;
122122
%Docstring
123-
Returns the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
123+
Returns the coordinate custom CRS used when the project coordinate type is set to :py:class:`Qgis`.CoordinateDisplayType.CustomCrs.
124124

125125
.. seealso:: :py:func:`setCoordinateCustomCrs`
126126

@@ -129,7 +129,7 @@ Returns the coordinate custom CRS used when the project coordinate type is set t
129129

130130
void setCoordinateCustomCrs( const QgsCoordinateReferenceSystem &crs );
131131
%Docstring
132-
Sets the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
132+
Sets the coordinate custom CRS used when the project coordinate type is set to :py:class:`Qgis`.CoordinateDisplayType.CustomCrs.
133133

134134
.. seealso:: :py:func:`setCoordinateCustomCrs`
135135

‎python/core/auto_generated/providers/arcgis/qgsarcgisportalutils.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
149149
:param contentUrl: should be set to the Portal's content URL, e.g. https://mysite.com/portal/sharing/rest/content
150150
:param groupId: ID of group to query
151151
:param authcfg: authentication configuration ID
152-
:param itemTypes: list of desired item types (using Qgis.ArcGisRestServiceType values)
152+
:param itemTypes: list of desired item types (using :py:class:`Qgis`.ArcGisRestServiceType values)
153153
:param requestHeaders: optional additional request headers
154154
:param feedback: optional feedback argument for cancellation support
155155
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
@@ -170,7 +170,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
170170
:param contentUrl: should be set to the Portal's content URL, e.g. https://mysite.com/portal/sharing/rest/content
171171
:param groupId: ID of group to query
172172
:param authcfg: authentication configuration ID
173-
:param itemTypes: list of desired item types (using Qgis.ArcGisRestServiceType values)
173+
:param itemTypes: list of desired item types (using :py:class:`Qgis`.ArcGisRestServiceType values)
174174
:param requestHeaders: optional additional request headers
175175
:param feedback: optional feedback argument for cancellation support
176176
:param pageSize: number of results to retrieve for each request. Maximum value is 100.

‎python/core/auto_generated/providers/qgsabstractdatabaseproviderconnection.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Returns the number of fetched rows.
9393

9494
long long rowCount( ) const;
9595
%Docstring
96-
Returns the number of rows returned by a SELECT query or Qgis.FeatureCountState.UnknownCount if unknown.
96+
Returns the number of rows returned by a SELECT query or :py:class:`Qgis`.FeatureCountState.UnknownCount if unknown.
9797

9898
.. seealso:: :py:func:`fetchedRowCount`
9999
%End

‎python/core/auto_generated/providers/qgsprovidersublayerdetails.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ the hierarchy of a dataset which organises layers in schemas or in an internal f
179179
%Docstring
180180
Returns the layer's feature count.
181181

182-
Will return Qgis.FeatureCountState.UnknownCount or Qgis.FeatureCountState.Uncounted if no feature count is applicable or available.
182+
Will return :py:class:`Qgis`.FeatureCountState.UnknownCount or :py:class:`Qgis`.FeatureCountState.Uncounted if no feature count is applicable or available.
183183

184184
.. seealso:: :py:func:`setFeatureCount`
185185
%End
@@ -188,7 +188,7 @@ Will return Qgis.FeatureCountState.UnknownCount or Qgis.FeatureCountState.Uncoun
188188
%Docstring
189189
Sets the layer's feature ``count``.
190190

191-
Set to Qgis.FeatureCountState.UnknownCount or Qgis.FeatureCountState.Uncounted if no feature count is applicable or available.
191+
Set to :py:class:`Qgis`.FeatureCountState.UnknownCount or :py:class:`Qgis`.FeatureCountState.Uncounted if no feature count is applicable or available.
192192

193193
.. seealso:: :py:func:`featureCount`
194194
%End

‎python/core/auto_generated/providers/qgsproviderutils.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Returns ``True`` if the sublayer ``details`` are incomplete, and require a more
3636
scan.
3737

3838
For instance, if the details contain any vector sublayers with unknown geometry types
39-
then a query with the Qgis.SublayerQueryFlag.ResolveGeometryType flag is required.
39+
then a query with the :py:class:`Qgis`.SublayerQueryFlag.ResolveGeometryType flag is required.
4040

4141
The ``flags`` argument can be used to control the level of completeness required during the test.
4242
%End

‎python/core/auto_generated/qgis.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ int QgisEvent = QEvent::User + 1;
2323
class Qgis
2424
{
2525
%Docstring(signature="appended")
26-
The Qgis class provides global constants for use throughout the application.
26+
The :py:class:`Qgis` class provides global constants for use throughout the application.
2727
%End
2828

2929
%TypeHeaderCode

‎python/core/auto_generated/qgsfeaturerequest.sip.in

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ The request may apply an attribute/ID filter to fetch only a particular subset o
2424
Additionally a spatial filter can be set in combination with the attribute/ID filter. Supported
2525
spatial filters are:
2626

27-
- Qgis.SpatialFilterType.BoundingBox: Only features that intersect a given rectangle will be fetched. For the sake of speed, the intersection is often done only using feature's bounding box. There is a flag ExactIntersect that makes sure that only intersecting features will be returned.
28-
- Qgis.SpatialFilterType.DistanceWithin: Only features within a specified distance of a reference geometry will be fetched.
27+
- :py:class:`Qgis`.SpatialFilterType.BoundingBox: Only features that intersect a given rectangle will be fetched. For the sake of speed, the intersection is often done only using feature's bounding box. There is a flag ExactIntersect that makes sure that only intersecting features will be returned.
28+
- :py:class:`Qgis`.SpatialFilterType.DistanceWithin: Only features within a specified distance of a reference geometry will be fetched.
2929

3030
For efficiency, it is also possible to tell provider that some data is not required:
3131

@@ -351,8 +351,8 @@ When a destination CRS is set using :py:func:`~QgsFeatureRequest.setDestinationC
351351
is expected to be in the same CRS as the :py:func:`~QgsFeatureRequest.destinationCrs`. Otherwise, ``rectangle``
352352
should use the same CRS as the source layer/provider.
353353

354-
Calling this method will automatically set :py:func:`~QgsFeatureRequest.spatialFilterType` to Qgis.SpatialFilterType.BoundingBox.
355-
If ``rectangle`` is a null rectangle then :py:func:`~QgsFeatureRequest.spatialFilterType` will be reset to Qgis.SpatialFilterType.NoFilter.
354+
Calling this method will automatically set :py:func:`~QgsFeatureRequest.spatialFilterType` to :py:class:`Qgis`.SpatialFilterType.BoundingBox.
355+
If ``rectangle`` is a null rectangle then :py:func:`~QgsFeatureRequest.spatialFilterType` will be reset to :py:class:`Qgis`.SpatialFilterType.NoFilter.
356356

357357
.. seealso:: :py:func:`filterRect`
358358
%End
@@ -362,9 +362,9 @@ If ``rectangle`` is a null rectangle then :py:func:`~QgsFeatureRequest.spatialFi
362362
Returns the rectangle from which features will be taken. If the returned
363363
rectangle is null, then no filter rectangle is set.
364364

365-
If :py:func:`~QgsFeatureRequest.spatialFilterType` is Qgis.SpatialFilterType.BoundingBox then only
365+
If :py:func:`~QgsFeatureRequest.spatialFilterType` is :py:class:`Qgis`.SpatialFilterType.BoundingBox then only
366366
features from within this bounding box will be fetched. If :py:func:`~QgsFeatureRequest.spatialFilterType`
367-
is Qgis.SpatialFilterType.DistanceWithin then the returned rectangle
367+
is :py:class:`Qgis`.SpatialFilterType.DistanceWithin then the returned rectangle
368368
represents the bounding box of the :py:func:`~QgsFeatureRequest.referenceGeometry` extended by :py:func:`~QgsFeatureRequest.distanceWithin`.
369369

370370
When a destination CRS is set using :py:func:`~QgsFeatureRequest.setDestinationCrs`, the rectangle
@@ -385,7 +385,7 @@ the spatial units of the :py:func:`~QgsFeatureRequest.destinationCrs`. Otherwise
385385
should use the same CRS as the source layer/provider and ``distance``
386386
should use the spatial units as this same CRS.
387387

388-
Calling this method will automatically set :py:func:`~QgsFeatureRequest.spatialFilterType` to Qgis.SpatialFilterType.DistanceWithin.
388+
Calling this method will automatically set :py:func:`~QgsFeatureRequest.spatialFilterType` to :py:class:`Qgis`.SpatialFilterType.DistanceWithin.
389389

390390
.. seealso:: :py:func:`filterRect`
391391

@@ -396,7 +396,7 @@ Calling this method will automatically set :py:func:`~QgsFeatureRequest.spatialF
396396
%Docstring
397397
Returns the reference geometry used for spatial filtering of features.
398398

399-
When :py:func:`~QgsFeatureRequest.spatialFilterType` is Qgis.SpatialFilterType.DistanceWithin then only
399+
When :py:func:`~QgsFeatureRequest.spatialFilterType` is :py:class:`Qgis`.SpatialFilterType.DistanceWithin then only
400400
features within :py:func:`~QgsFeatureRequest.distanceWithin` units of the reference geometry will be
401401
fetched.
402402

@@ -413,7 +413,7 @@ will use the same CRS as the source layer/provider.
413413
double distanceWithin() const;
414414
%Docstring
415415
Returns the maximum distance from the :py:func:`~QgsFeatureRequest.referenceGeometry` of fetched
416-
features, if :py:func:`~QgsFeatureRequest.spatialFilterType` is Qgis.SpatialFilterType.DistanceWithin.
416+
features, if :py:func:`~QgsFeatureRequest.spatialFilterType` is :py:class:`Qgis`.SpatialFilterType.DistanceWithin.
417417

418418
When a destination CRS is set using :py:func:`~QgsFeatureRequest.setDestinationCrs`, the distance
419419
will be in the spatial units of :py:func:`~QgsFeatureRequest.destinationCrs`. Otherwise, the distance

‎python/core/auto_generated/qgsfield.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Returns the field comment
179179
%Docstring
180180
Returns the map of field metadata.
181181

182-
Map keys should match values from the Qgis.FieldMetadataProperty enum.
182+
Map keys should match values from the :py:class:`Qgis`.FieldMetadataProperty enum.
183183

184184
.. seealso:: :py:func:`setMetadata`
185185

@@ -200,7 +200,7 @@ Returns a specific metadata ``property``.
200200
%Docstring
201201
Sets the map of field ``metadata``.
202202

203-
Map keys should match values from the Qgis.FieldMetadataProperty enum.
203+
Map keys should match values from the :py:class:`Qgis`.FieldMetadataProperty enum.
204204

205205
.. seealso:: :py:func:`metadata`
206206

‎python/core/auto_generated/qgsmessagelog.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ value for the message.
5757

5858
void messageReceived( bool received );
5959
%Docstring
60-
Emitted whenever the log receives a message which is not a Qgis.MessageLevel.Info level message
60+
Emitted whenever the log receives a message which is not a :py:class:`Qgis`.MessageLevel.Info level message
6161
and which has the ``notifyUser`` flag as ``True``.
6262

6363
If :py:class:`QgsMessageLogNotifyBlocker` objects have been created then this signal may be

‎python/core/auto_generated/qgsrendercontext.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -731,8 +731,8 @@ Converts a size from the specified units to painter units (pixels). The conversi
731731
specified by the optional scale parameter.
732732

733733
Since QGIS 3.22 the optional ``property`` argument can be used to specify the associated property. This
734-
is used in some contexts to refine the converted size. For example, a Qgis.RenderSubcomponentProperty.BlurSize
735-
property will be limited to a suitably fast range when the render context has the Qgis.RenderContextFlag.RenderSymbolPreview set.
734+
is used in some contexts to refine the converted size. For example, a :py:class:`Qgis`.RenderSubcomponentProperty.BlurSize
735+
property will be limited to a suitably fast range when the render context has the :py:class:`Qgis`.RenderContextFlag.RenderSymbolPreview set.
736736

737737
.. seealso:: :py:func:`convertToMapUnits`
738738

‎python/core/auto_generated/qgssnappingconfig.sip.in

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,38 +44,38 @@ This is a container for configuration of the snapping of the project
4444
static QString snappingTypeToString( Qgis::SnappingType type );
4545
%Docstring
4646
Convenient method to returns the translated name of the enum type
47-
Qgis.SnappingTypes.
47+
:py:class:`Qgis`.SnappingTypes.
4848

4949
.. versionadded:: 3.26
5050
%End
5151

5252
static QString snappingTypeFlagToString( Qgis::SnappingType type ) /Deprecated/;
5353
%Docstring
5454
Convenient method to return the translated name of the enum type
55-
Qgis.SnappingTypes.
55+
:py:class:`Qgis`.SnappingTypes.
5656

5757
.. versionadded:: 3.12
5858

5959
.. deprecated:: QGIS 3.26
60-
use Qgis.snappingTypeToString instead
60+
use :py:class:`Qgis`.snappingTypeToString instead
6161
%End
6262

6363

6464
static QIcon snappingTypeToIcon( Qgis::SnappingType type );
6565
%Docstring
6666
Convenient method to return an icon corresponding to the enum type
67-
Qgis.SnappingTypes.
67+
:py:class:`Qgis`.SnappingTypes.
6868

6969
.. versionadded:: 3.20
7070
%End
7171

7272
static QIcon snappingTypeFlagToIcon( Qgis::SnappingType type ) /Deprecated/;
7373
%Docstring
7474
Convenient method to return an icon corresponding to the enum type
75-
Qgis.SnappingTypes.
75+
:py:class:`Qgis`.SnappingTypes.
7676

7777
.. deprecated:: QGIS 3.26
78-
use Qgis.snappingTypeToString instead
78+
use :py:class:`Qgis`.snappingTypeToString instead
7979

8080
.. versionadded:: 3.20
8181
%End
@@ -103,7 +103,7 @@ IndividualLayerSettings
103103
:param units:
104104

105105
.. deprecated:: QGIS 3.12
106-
use the method with Qgis.SnappingTypes instead.
106+
use the method with :py:class:`Qgis`.SnappingTypes instead.
107107
%End
108108

109109
IndividualLayerSettings( bool enabled, Qgis::SnappingTypes type, double tolerance, QgsTolerance::UnitType units, double minScale = 0.0, double maxScale = 0.0 );

‎python/core/auto_generated/raster/qgsrasteridentifyresult.sip.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ Returns the results format.
5656
%Docstring
5757
Returns the identify results. Results are different for each format:
5858

59-
- Qgis.RasterIdentifyFormat.Value: a map of values for each band, where keys are band numbers (from 1).
60-
- Qgis.RasterIdentifyFormat.Feature: a map of WMS sublayer keys and lists of :py:class:`QgsFeatureStore` values.
61-
- Qgis.RasterIdentifyFormat.Html: a map of WMS sublayer keys and HTML strings.
59+
- :py:class:`Qgis`.RasterIdentifyFormat.Value: a map of values for each band, where keys are band numbers (from 1).
60+
- :py:class:`Qgis`.RasterIdentifyFormat.Feature: a map of WMS sublayer keys and lists of :py:class:`QgsFeatureStore` values.
61+
- :py:class:`Qgis`.RasterIdentifyFormat.Html: a map of WMS sublayer keys and HTML strings.
6262
%End
6363

6464
void setParams( const QMap<QString, QVariant> &params );

‎python/core/auto_generated/settings/qgssettings.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ Returns the origin of the setting if it exists at the given ``key``
220220

221221
.. note::
222222

223-
it will return Qgis.SettingsOrigin.Any if the key doesn't exist
223+
it will return :py:class:`Qgis`.SettingsOrigin.Any if the key doesn't exist
224224

225225
.. versionadded:: 3.30
226226
%End

‎python/core/auto_generated/settings/qgssettingsentry.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Returns the origin of the setting if it exists
164164

165165
.. note::
166166

167-
it will return Qgis.SettingsOrigin.Any if the key doesn't exist
167+
it will return :py:class:`Qgis`.SettingsOrigin.Any if the key doesn't exist
168168

169169
.. versionadded:: 3.30
170170
%End

‎python/core/auto_generated/symbology/qgslinesymbollayer.sip.in

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -718,12 +718,12 @@ Sets the ``placement`` of the symbols.
718718
%Docstring
719719
Returns ``True`` if the placement applies for every part of multi-part feature geometries.
720720

721-
The default is ``True``, which means that Qgis.MarkerLinePlacement.FirstVertex or
722-
Qgis.MarkerLinePlacement.LastVertex placements will result in a symbol on
721+
The default is ``True``, which means that :py:class:`Qgis`.MarkerLinePlacement.FirstVertex or
722+
:py:class:`Qgis`.MarkerLinePlacement.LastVertex placements will result in a symbol on
723723
the first/last vertex of EVERY part of a multipart feature.
724724

725-
If ``False``, then Qgis.MarkerLinePlacement.FirstVertex or
726-
Qgis.MarkerLinePlacement.LastVertex placements will result in a symbol on
725+
If ``False``, then :py:class:`Qgis`.MarkerLinePlacement.FirstVertex or
726+
:py:class:`Qgis`.MarkerLinePlacement.LastVertex placements will result in a symbol on
727727
the first/last vertex of the overall multipart geometry only.
728728

729729
.. seealso:: :py:func:`setPlaceOnEveryPart`
@@ -735,12 +735,12 @@ the first/last vertex of the overall multipart geometry only.
735735
%Docstring
736736
Sets whether the placement applies for every part of multi-part feature geometries.
737737

738-
The default is ``True``, which means that Qgis.MarkerLinePlacement.FirstVertex or
739-
Qgis.MarkerLinePlacement.LastVertex placements will result in a symbol on
738+
The default is ``True``, which means that :py:class:`Qgis`.MarkerLinePlacement.FirstVertex or
739+
:py:class:`Qgis`.MarkerLinePlacement.LastVertex placements will result in a symbol on
740740
the first/last vertex of EVERY part of a multipart feature.
741741

742-
If ``False``, then Qgis.MarkerLinePlacement.FirstVertex or
743-
Qgis.MarkerLinePlacement.LastVertex placements will result in a symbol on
742+
If ``False``, then :py:class:`Qgis`.MarkerLinePlacement.FirstVertex or
743+
:py:class:`Qgis`.MarkerLinePlacement.LastVertex placements will result in a symbol on
744744
the first/last vertex of the overall multipart geometry only.
745745

746746
.. seealso:: :py:func:`placeOnEveryPart`

‎python/core/auto_generated/symbology/qgsstyle.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ with the specified ``name``, or an empty list if a matching 3d symbol is not pre
400400
Qgis::GeometryType labelSettingsLayerType( const QString &name ) const;
401401
%Docstring
402402
Returns the layer geometry type corresponding to the label settings
403-
with the specified ``name``, or Qgis.GeometryType.Unknown
403+
with the specified ``name``, or :py:class:`Qgis`.GeometryType.Unknown
404404
if matching label settings are not present.
405405

406406
.. versionadded:: 3.10

‎python/core/auto_generated/symbology/qgsstylemodel.sip.in

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Returns the symbol type filter.
193193

194194
.. note::
195195

196-
This filter is only active if Qgis.SymbolTypeFilterEnabled() is ``True``, and has
196+
This filter is only active if :py:class:`Qgis`.SymbolTypeFilterEnabled() is ``True``, and has
197197
no effect on non-symbol entities (i.e. color ramps).
198198

199199
.. seealso:: :py:func:`setSymbolType`
@@ -205,7 +205,7 @@ Sets the symbol ``type`` filter.
205205

206206
.. note::
207207

208-
This filter is only active if Qgis.SymbolTypeFilterEnabled() is ``True``.
208+
This filter is only active if :py:class:`Qgis`.SymbolTypeFilterEnabled() is ``True``.
209209

210210
.. seealso:: Qgis.SymbolType
211211
%End
@@ -223,7 +223,7 @@ Returns ``True`` if filtering by symbol type is enabled.
223223
%Docstring
224224
Sets whether filtering by symbol type is ``enabled``.
225225

226-
If ``enabled`` is ``False``, then the value of Qgis.SymbolType() will have no
226+
If ``enabled`` is ``False``, then the value of :py:class:`Qgis`.SymbolType() will have no
227227
effect on the model filtering. This has
228228
no effect on non-symbol entities (i.e. color ramps).
229229

@@ -234,7 +234,7 @@ no effect on non-symbol entities (i.e. color ramps).
234234

235235
Qgis::GeometryType layerType() const;
236236
%Docstring
237-
Returns the layer type filter, or Qgis.GeometryType.Unknown if no
237+
Returns the layer type filter, or :py:class:`Qgis`.GeometryType.Unknown if no
238238
layer type filter is present.
239239

240240
This setting has an effect on label settings entities and 3d symbols only.
@@ -244,7 +244,7 @@ This setting has an effect on label settings entities and 3d symbols only.
244244

245245
void setLayerType( Qgis::GeometryType type );
246246
%Docstring
247-
Sets the layer ``type`` filter. Set ``type`` to Qgis.GeometryType.Unknown if no
247+
Sets the layer ``type`` filter. Set ``type`` to :py:class:`Qgis`.GeometryType.Unknown if no
248248
layer type filter is desired.
249249

250250
.. seealso:: :py:func:`layerType`

‎python/core/auto_generated/textrenderer/qgstextdocumentmetrics.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ sub script elements)
5959

6060
.. warning::
6161

62-
Currently this is only supported for the Qgis.TextLayoutMode.Labeling mode.
62+
Currently this is only supported for the :py:class:`Qgis`.TextLayoutMode.Labeling mode.
6363

6464
.. versionadded:: 3.30
6565
%End

‎python/core/auto_generated/textrenderer/qgstextrenderer.sip.in

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ and background shapes.
2727

2828
static Qgis::TextHorizontalAlignment convertQtHAlignment( Qt::Alignment alignment );
2929
%Docstring
30-
Converts a Qt horizontal ``alignment`` flag to a Qgis.TextHorizontalAlignment value.
30+
Converts a Qt horizontal ``alignment`` flag to a :py:class:`Qgis`.TextHorizontalAlignment value.
3131

3232
.. seealso:: :py:func:`convertQtVAlignment`
3333

@@ -36,7 +36,7 @@ Converts a Qt horizontal ``alignment`` flag to a Qgis.TextHorizontalAlignment va
3636

3737
static Qgis::TextVerticalAlignment convertQtVAlignment( Qt::Alignment alignment );
3838
%Docstring
39-
Converts a Qt vertical ``alignment`` flag to a Qgis.TextVerticalAlignment value.
39+
Converts a Qt vertical ``alignment`` flag to a :py:class:`Qgis`.TextVerticalAlignment value.
4040

4141
.. seealso:: :py:func:`convertQtHAlignment`
4242

@@ -76,7 +76,7 @@ Draws text within a rectangle using the specified settings.
7676
as of QGIS 3.4.3 and the text format should be set using :py:func:`QgsRenderContext.setTextRenderFormat()` instead.
7777
:param vAlignment: vertical alignment (since QGIS 3.16)
7878
:param flags: text rendering flags (since QGIS 3.24)
79-
:param mode: text layout mode. Only Qgis.TextLayoutMode.Rectangle, Qgis.TextLayoutMode.RectangleCapHeightBased and Qgis.TextLayoutMode.RectangleAscentBased are accepted (since QGIS 3.30)
79+
:param mode: text layout mode. Only :py:class:`Qgis`.TextLayoutMode.Rectangle, :py:class:`Qgis`.TextLayoutMode.RectangleCapHeightBased and :py:class:`Qgis`.TextLayoutMode.RectangleAscentBased are accepted (since QGIS 3.30)
8080

8181
.. seealso:: :py:func:`drawDocument`
8282
%End
@@ -110,7 +110,7 @@ been calculated.
110110
:param horizontalAlignment: horizontal alignment
111111
:param verticalAlignment: vertical alignment
112112
:param rotation: text rotation
113-
:param mode: text layout mode. Only Qgis.TextLayoutMode.Rectangle, Qgis.TextLayoutMode.RectangleCapHeightBased and Qgis.TextLayoutMode.RectangleAscentBased are accepted.
113+
:param mode: text layout mode. Only :py:class:`Qgis`.TextLayoutMode.Rectangle, :py:class:`Qgis`.TextLayoutMode.RectangleCapHeightBased and :py:class:`Qgis`.TextLayoutMode.RectangleAscentBased are accepted.
114114
:param flags: text rendering flags
115115

116116

@@ -254,7 +254,7 @@ Returns the height of a text based on a given format.
254254
:param mode: draw mode
255255
:param fontMetrics: font metrics
256256
:param flags: text renderer flags (since QGIS 3.24)
257-
:param maxLineWidth: maximum line width, in painter units. Used when the Qgis.TextRendererFlag.WrapLines flag is used (since QGIS 3.24)
257+
:param maxLineWidth: maximum line width, in painter units. Used when the :py:class:`Qgis`.TextRendererFlag.WrapLines flag is used (since QGIS 3.24)
258258
%End
259259

260260
static double textHeight( const QgsRenderContext &context, const QgsTextFormat &format, QChar character, bool includeEffects = false );

‎python/core/auto_generated/vector/qgsvectorlayer.sip.in

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1316,7 +1316,7 @@ Adds a ring to polygon/multipolygon features
13161316
:param ring: ring to add
13171317
:param featureId: if specified, feature ID for feature ring was added to will be stored in this parameter
13181318

1319-
:return: Qgis.GeometryOperationResult
1319+
:return: :py:class:`Qgis`.GeometryOperationResult
13201320

13211321
- Success
13221322
- LayerNotEditable
@@ -1345,7 +1345,7 @@ Adds a ring to polygon/multipolygon features
13451345
:param ring: ring to add
13461346
:param featureId: if specified, feature ID for feature ring was added to will be stored in this parameter
13471347

1348-
:return: Qgis.GeometryOperationResult
1348+
:return: :py:class:`Qgis`.GeometryOperationResult
13491349

13501350
- Success
13511351
- LayerNotEditable
@@ -1370,7 +1370,7 @@ Adds a ring to polygon/multipolygon features (takes ownership)
13701370
:param ring: ring to add
13711371
:param featureId: if specified, feature ID for feature ring was added to will be stored in this parameter
13721372

1373-
:return: Qgis.GeometryOperationResult
1373+
:return: :py:class:`Qgis`.GeometryOperationResult
13741374

13751375
- Success
13761376
- LayerNotEditable
@@ -1396,7 +1396,7 @@ Adds a ring to polygon/multipolygon features (takes ownership)
13961396
%Docstring
13971397
Adds a new part polygon to a multipart feature
13981398

1399-
:return: Qgis.GeometryOperationResult
1399+
:return: :py:class:`Qgis`.GeometryOperationResult
14001400

14011401
- Success
14021402
- LayerNotEditable
@@ -1423,7 +1423,7 @@ Adds a new part polygon to a multipart feature
14231423
%Docstring
14241424
Adds a new part polygon to a multipart feature
14251425

1426-
:return: Qgis.GeometryOperationResult
1426+
:return: :py:class:`Qgis`.GeometryOperationResult
14271427

14281428
- Success
14291429
- LayerNotEditable
@@ -1453,7 +1453,7 @@ Adds a new part polygon to a multipart feature
14531453
%Docstring
14541454
Adds a new part polygon to a multipart feature
14551455

1456-
:return: Qgis.GeometryOperationResult
1456+
:return: :py:class:`Qgis`.GeometryOperationResult
14571457

14581458
- Success
14591459
- LayerNotEditable
@@ -1516,7 +1516,7 @@ Splits parts cut by the given line
15161516
:param splitLine: line that splits the layer features
15171517
:param topologicalEditing: ``True`` if topological editing is enabled
15181518

1519-
:return: Qgis.GeometryOperationResult
1519+
:return: :py:class:`Qgis`.GeometryOperationResult
15201520

15211521
- Success
15221522
- NothingHappened
@@ -1544,7 +1544,7 @@ Splits parts cut by the given line
15441544
:param splitLine: line that splits the layer features
15451545
:param topologicalEditing: ``True`` if topological editing is enabled
15461546

1547-
:return: Qgis.GeometryOperationResult
1547+
:return: :py:class:`Qgis`.GeometryOperationResult
15481548

15491549
- Success
15501550
- NothingHappened
@@ -1569,7 +1569,7 @@ Splits features cut by the given line
15691569
:param splitLine: line that splits the layer features
15701570
:param topologicalEditing: ``True`` if topological editing is enabled
15711571

1572-
:return: Qgis.GeometryOperationResult
1572+
:return: :py:class:`Qgis`.GeometryOperationResult
15731573

15741574
- Success
15751575
- NothingHappened
@@ -1597,7 +1597,7 @@ Splits features cut by the given line
15971597
:param splitLine: line that splits the layer features
15981598
:param topologicalEditing: ``True`` if topological editing is enabled
15991599

1600-
:return: Qgis.GeometryOperationResult
1600+
:return: :py:class:`Qgis`.GeometryOperationResult
16011601

16021602
- Success
16031603
- NothingHappened
@@ -1624,7 +1624,7 @@ Splits features cut by the given curve
16241624
:param preserveCircular: whether circular strings are preserved after splitting
16251625
:param topologicalEditing: ``True`` if topological editing is enabled
16261626

1627-
:return: Qgis.GeometryOperationResult
1627+
:return: :py:class:`Qgis`.GeometryOperationResult
16281628

16291629
- Success
16301630
- NothingHappened

‎python/core/auto_generated/vector/qgsvectorlayerelevationproperties.sip.in

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ Returns the symbology option used to render the vector profile in elevation prof
253253

254254
.. note::
255255

256-
This setting is only used when :py:func:`~QgsVectorLayerElevationProperties.type` is Qgis.VectorProfileType.ContinuousSurface.
256+
This setting is only used when :py:func:`~QgsVectorLayerElevationProperties.type` is :py:class:`Qgis`.VectorProfileType.ContinuousSurface.
257257

258258
.. seealso:: :py:func:`setProfileSymbology`
259259
%End
@@ -264,7 +264,7 @@ Sets the ``symbology`` option used to render the vector profile in elevation pro
264264

265265
.. note::
266266

267-
This setting is only used when :py:func:`~QgsVectorLayerElevationProperties.type` is Qgis.VectorProfileType.ContinuousSurface.
267+
This setting is only used when :py:func:`~QgsVectorLayerElevationProperties.type` is :py:class:`Qgis`.VectorProfileType.ContinuousSurface.
268268

269269
.. seealso:: :py:func:`setProfileSymbology`
270270
%End
@@ -275,7 +275,7 @@ Returns ``True`` if the marker symbol should also be shown in continuous surface
275275

276276
.. note::
277277

278-
This setting is only used when :py:func:`~QgsVectorLayerElevationProperties.type` is Qgis.VectorProfileType.ContinuousSurface.
278+
This setting is only used when :py:func:`~QgsVectorLayerElevationProperties.type` is :py:class:`Qgis`.VectorProfileType.ContinuousSurface.
279279

280280
.. seealso:: :py:func:`setShowMarkerSymbolInSurfacePlots`
281281
%End
@@ -286,7 +286,7 @@ Sets whehter the marker symbol should also be shown in continuous surface plots.
286286

287287
.. note::
288288

289-
This setting is only used when :py:func:`~QgsVectorLayerElevationProperties.type` is Qgis.VectorProfileType.ContinuousSurface.
289+
This setting is only used when :py:func:`~QgsVectorLayerElevationProperties.type` is :py:class:`Qgis`.VectorProfileType.ContinuousSurface.
290290

291291
.. seealso:: :py:func:`showMarkerSymbolInSurfacePlots`
292292
%End

‎python/gui/auto_generated/codeeditors/qgscodeeditor.sip.in

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ Stores the commands executed in the editor to the persistent history file.
431431
%Docstring
432432
Applies code reformatting to the editor.
433433

434-
This is only supported for editors which return the Qgis.ScriptLanguageCapability.Reformat capability from :py:func:`~QgsCodeEditor.languageCapabilities`.
434+
This is only supported for editors which return the :py:class:`Qgis`.ScriptLanguageCapability.Reformat capability from :py:func:`~QgsCodeEditor.languageCapabilities`.
435435

436436
.. versionadded:: 3.32
437437
%End
@@ -440,7 +440,7 @@ This is only supported for editors which return the Qgis.ScriptLanguageCapabilit
440440
%Docstring
441441
Applies syntax checking to the editor.
442442

443-
This is only supported for editors which return the Qgis.ScriptLanguageCapability.CheckSyntax capability from :py:func:`~QgsCodeEditor.languageCapabilities`.
443+
This is only supported for editors which return the :py:class:`Qgis`.ScriptLanguageCapability.CheckSyntax capability from :py:func:`~QgsCodeEditor.languageCapabilities`.
444444

445445
.. versionadded:: 3.32
446446
%End
@@ -449,7 +449,7 @@ This is only supported for editors which return the Qgis.ScriptLanguageCapabilit
449449
%Docstring
450450
Toggle comment for the selected text.
451451

452-
This is only supported for editors which return the Qgis.ScriptLanguageCapability.ToggleComment capability from :py:func:`~QgsCodeEditor.languageCapabilities`.
452+
This is only supported for editors which return the :py:class:`Qgis`.ScriptLanguageCapability.ToggleComment capability from :py:func:`~QgsCodeEditor.languageCapabilities`.
453453

454454
.. versionadded:: 3.32
455455
%End
@@ -547,7 +547,7 @@ actions to the context menu.
547547
%Docstring
548548
Applies code reformatting to a ``string`` and returns the result.
549549

550-
This is only supported for editors which return the Qgis.ScriptLanguageCapability.Reformat capability from :py:func:`~QgsCodeEditor.languageCapabilities`.
550+
This is only supported for editors which return the :py:class:`Qgis`.ScriptLanguageCapability.Reformat capability from :py:func:`~QgsCodeEditor.languageCapabilities`.
551551

552552
.. versionadded:: 3.32
553553
%End

‎python/gui/auto_generated/qgsmaptool.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ Emit map tool changed with the old tool
203203
%Docstring
204204
Gets search radius in mm. Used by identify, tip etc.
205205
The values is currently set in identify tool options (move somewhere else?)
206-
and defaults to Qgis.DEFAULT_SEARCH_RADIUS_MM.
206+
and defaults to :py:class:`Qgis`.DEFAULT_SEARCH_RADIUS_MM.
207207

208208
.. versionadded:: 2.3
209209
%End

‎python/gui/auto_generated/qgsmessagebar.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Display a ``widget`` as a message on the bar, after hiding the currently visible
5656
and putting it in a stack.
5757

5858
:param widget: message widget to display
59-
:param level: is Qgis.MessageLevel.Info, Warning, Critical or Success
59+
:param level: is :py:class:`Qgis`.MessageLevel.Info, Warning, Critical or Success
6060
:param duration: timeout duration of message in seconds, 0 value indicates no timeout (i.e.
6161
the message must be manually cleared by the user).
6262
%End

‎python/gui/auto_generated/qgsrubberband.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Creates a new RubberBand.
7272
Its CRS will be used to map points onto screen coordinates.
7373
The ownership is transferred to this canvas.
7474
:param geometryType: Defines how the data should be drawn onto the screen.
75-
Qgis.GeometryType.Line, Qgis.GeometryType.Polygon or Qgis.GeometryType.Point
75+
:py:class:`Qgis`.GeometryType.Line, :py:class:`Qgis`.GeometryType.Polygon or :py:class:`Qgis`.GeometryType.Point
7676
%End
7777
~QgsRubberBand();
7878

@@ -188,7 +188,7 @@ Sets the style of the brush
188188
Clears all the geometries in this rubberband.
189189
Sets the representation type according to geometryType.
190190

191-
:param geometryType: Defines how the data should be drawn onto the screen. (Use Qgis.Line, Qgis.Polygon or Qgis.Point)
191+
:param geometryType: Defines how the data should be drawn onto the screen. (Use :py:class:`Qgis`.Line, :py:class:`Qgis`.Polygon or :py:class:`Qgis`.Point)
192192
%End
193193

194194
void addPoint( const QgsPointXY &p, bool doUpdate = true, int geometryIndex = 0, int ringIndex = 0 );

‎python/gui/auto_generated/qgsstyleitemslistwidget.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Sets the ``type`` of symbols to show in the widget.
5555

5656
void setLayerType( Qgis::GeometryType type );
5757
%Docstring
58-
Sets the layer ``type`` to show in the widget. Set ``type`` to Qgis.GeometryType.Unknown if no
58+
Sets the layer ``type`` to show in the widget. Set ``type`` to :py:class:`Qgis`.GeometryType.Unknown if no
5959
layer type filter is desired.
6060

6161
This setting only applies to label settings and 3d style entities.

‎python/server/auto_generated/qgsserverprojectutils.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -514,8 +514,8 @@ This is calculated from (in order of precedence):
514514
- Value defined in the project per service
515515
- The ``QGIS_SERVER_<service>_SERVICE_URL`` environment variable
516516
- The ``QGIS_SERVER_SERVICE_URL`` environment variable
517-
- The custom ``X-Qgis-<service>-Service-Url`` header
518-
- The custom ``X-Qgis-Service-Url`` header
517+
- The custom ``X-:py:class:`Qgis`-<service>-Service-Url`` header
518+
- The custom ``X-:py:class:`Qgis`-Service-Url`` header
519519
- Build from the standard ``Forwarded`` header
520520
- Build from the pseudo standard ``X-Forwarded-Host`` and ``X-Forwarded-Proto`` headers
521521
- Build from the standard ``Host`` header and the server protocol

‎python/server/auto_generated/qgsserversettings.sip.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Returns ``True`` if profile information has to be added to the logs, default val
137137

138138
.. note::
139139

140-
this flag is only effective when :py:func:`~QgsServerSettings.logLevel` returns Qgis.MessageLevel.Info (0)
140+
this flag is only effective when :py:func:`~QgsServerSettings.logLevel` returns :py:class:`Qgis`.MessageLevel.Info (0)
141141

142142
.. seealso:: :py:func:`logLevel`
143143

‎scripts/sipify.pl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,22 +164,22 @@ sub python_header {
164164
sub create_class_links {
165165
my $line = $_[0];
166166

167-
if ( $line =~ m/\b(Qgs[A-Z]\w+)\b(\.?$|[^\w]{2})/) {
167+
if ( $line =~ m/\b((?:Qgs[A-Z]\w+)|(?:Qgis))\b(\.?$|[^\w]{2})/) {
168168
if ( defined $ACTUAL_CLASS && $1 !~ $ACTUAL_CLASS ) {
169169
$line =~ s/\b(Qgs[A-Z]\w+)\b(\.?$|[^\w]{2})/:py:class:`$1`$2/g;
170170
}
171171
}
172-
$line =~ s/\b(Qgs[A-Z]\w+\.[a-z]\w+\(\))(?!\w)/:py:func:`$1`/g;
172+
$line =~ s/\b(((?:Qgs[A-Z]\w+)|(?:Qgis))\.[a-z]\w+\(\))(?!\w)/:py:func:`$1`/g;
173173
if ( defined $ACTUAL_CLASS && $ACTUAL_CLASS) {
174174
$line =~ s/(?<!\.)\b(?:([a-z]\w+)\(\))(?!\w)/:py:func:`~$ACTUAL_CLASS.$1`/g;
175175
}
176176
else {
177177
$line =~ s/(?<!\.)\b(?:([a-z]\w+)\(\))(?!\w)/:py:func:`~$1`/g;
178178
}
179179

180-
if ( $line =~ m/\b(?<![`~])(Qgs[A-Z]\w+)\b(?!\()/) {
180+
if ( $line =~ m/\b(?<![`~])((?:Qgs[A-Z]\w+)|(?:Qgis))\b(?!\()/) {
181181
if ( (!$ACTUAL_CLASS) || $1 ne $ACTUAL_CLASS ) {
182-
$line =~ s/\b(?<![`~])(Qgs[A-Z]\w+)\b(?!\()/:py:class:`$1`/g;
182+
$line =~ s/\b(?<![`~])((?:Qgs[A-Z]\w+)|(?:Qgis))\b(?!\()/:py:class:`$1`/g;
183183
}
184184
}
185185

0 commit comments

Comments
 (0)
Please sign in to comment.