[Qgis-developer] Can :class: :mod: :func: be removed from python cookbook?

[Matthias Kuhn]

On 01/20/2016 03:19 PM, Richard Duivenvoorde wrote:
> On 20-01-16 14:36, Matthias Kuhn wrote:
>> Hi Richard,
>>
>> It should be straightforward to extend sphinx to add whole domains
>> (py:class, py:mod, py:func) to the ignore list or add wildcard support.
>>
>> https://github.com/sphinx-doc/sphinx/issues/537
>>
>> https://github.com/sphinx-doc/sphinx/commit/f5ecd62d05fa5502795e31ac5cc8778c570269cd
> No, you have to add ALL individual classes...
I was thinking about a small pull request against sphinx to improve the
situation there.
Maintaining this list in the future will not make it easier for documenters.

But like Martin said, it's of limited use in its current shape anyway.

So either:

 * Make sphinx regex aware (or some other generalized pattern)
 * Generate the list from the source code rather than the documentation
 * Just drop it

Matthias
>
> As you see below, I grepped and was busy
> But then the func ones were even more..
>
> But I will try to set in my regexp/vim foo and try to get the full list
> of func type mod an class ....
>
> Regards,
>
> Richard
>
> This iwas current status:
>
>
> nitpick_ignore = [('py:class', 'QgsMapCanvas'),
>                   ('py:class', 'QgsMapRenderer'),
>                   ('py:class', 'QgsMapCanvasMap'),
>                   ('py:class', 'QgsMapCanvasItem'),
>                   ('py:class', 'QgsMapCanvasItem'),
>                   ('py:class', 'QgsMapToolPan'),
>                   ('py:class', 'QgsMapToolZoom'),
>                   ('py:class', 'QgsRubberBand'),
>                   ('py:class', 'QgsVertexMarker'),
>                   ('py:class', 'QgsMapTool'),
>                   ('py:class', 'QgsMessageBar'),
>                   ('py:class', 'QgsComposition'),
>                   ('py:class', 'QGraphicsScene'),
>                   ('py:class', 'QgsComposerItem'),
>                   ('py:class', 'QgsCoordinateReferenceSystem'),
>                   ('py:class', 'QgsCoordinateTransform'),
>                   ('py:class', 'QgsGeometry'),
>                   ('py:class', 'QgsPoint'),
>                   ('py:class', 'QgsDistanceArea'),
>                   ('py:class', 'QgsInterface'),
>                   ('py:class', 'QgsDataSourceURI'),
>                   ('py:class', 'QgsVectorLayer'),
>                   ('py:class', 'QgsProject'),
>                   ('py:class', 'QFileInfo'),
>                   ('py:class', 'QgsLayerTreeMapCanvasBridge'),
>                   ('py:class', 'QgsGraphAnalyzer'),
>                   ('py:class', 'QAction'),
>                   ('py:class', 'QMenu'),
>                   ('py:class', 'QgsRasterLayer'),
>                   ('py:class', 'QgsRasterRenderer'),
>                   ('py:class', 'QgsServerInterface'),
>                   ('py:class', 'QgsServerFilter'),
>                   ('py:class', 'QgsRequestHandler'),
>                   ('py:class', 'QgsMapServiceException'),
>                   ('py:class', 'QSettings'),
>                   ('py:class', 'QgsExpression'),
>                   ('py:class', 'QgsFeature'),
>                   ('py:class', 'QgsFiels'),
>                   ('py:class', 'QgsVectorLayerEditUtils'),
>                   ('py:class', 'QgsEditError'),
>                   ('py:class', 'QgsVectorFileWriter'),
>                   ('py:class', 'QgsSingleSymbolRendererV2'),
>                   ('py:class', 'QgsCategorizedSymbolRendererV2'),
>                   ('py:class', 'QgsGraduatedSymbolRendererV2'),
>                   ('py:class', 'QgsRendererV2Registry'),
>                   ('py:class', 'QgsMarkerSymbolV2'),
>                   ('py:class', 'QgsLineSymbolV2'),
>                   ('py:class', 'QgsFillSymbolV2'),
>                   ('py:class', 'QgsSymbolV2'),
>                   ('py:class', 'QgsSymbolLayerV2'),
>                   ('py:class', 'QgsFeatureRendererV2'),
>                   ('py:class', 'QgsRendererV2Widget'),
>                   ('py:class', 'QgsStyleV2'),
>                   ('py:class', 'QDomElement'),
>                   ('py:class', 'QgsVectorColorRampV2'),
>                   ('py:func', 'requestReady'),
>                   ('py:func', 'sendResponse'),
>                   ('py:func', 'pendingFields'),
>                   ('py:func', 'initAttributes'),
>                   ('py:func', 'commitChanges()'),
>                   ('py:func', 'setSymbol()'),
>                   ('py:func', 'createRenderer'),
> 			...
>                   ('py:mod', 'qgis.core'),
>                   ('py:mod', 'qgis.gui'),
>                   ('py:mod', 'qgis.utils'),
>                   ]
>
>
>
> _______________________________________________
> Qgis-developer mailing list
> Qgis-developer at lists.osgeo.org
> List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer

-- 
Matthias Kuhn
OPENGIS.ch - https://www.opengis.ch
Spatial • (Q)GIS • PostGIS • Open Source


-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: OpenPGP digital signature
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20160120/456ef726/attachment.sig>