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

Matthias Kuhn matthias at opengis.ch
Wed Jan 20 05:36:25 PST 2016

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.




On 01/20/2016 02:25 PM, Richard Duivenvoorde wrote:
> (sorry for cross posting)
> Hi Devs and Python cookbook writers,
> As you may know if you follow community list, we have a travis build now
> for QGIS documentation (and python cookbook then).
> To make Travis fail, I build the docs with an option that warning become
> errors, thereby making it clear for commiters that something broke.
> To try to make it fully warning free know, I hit warnings like:
> pyqgis_developer_cookbook/canvas.rst:21: WARNING: py:class reference
> target not found: QgsMapCanvas
> It turns out that Sphinx (off course) outside the source tree cannot
> resolve the reference to the QgsMapCanvas documentation....
> Then found the sphinx conf.py option:
> nitpick_ignore = [('py:class', 'QgsMapCanvas'),
>                   ('py:class', 'QgsMapRenderer')]
> BUT that only works if you put all classes referenced in it, and I'm not
> able to find a wildcard...
> So I find/added all classes... but then it start failing on :func: .....
> which is even more...
> So: is it ok for you if I just delete all this :class: stuff? So it will
> never be possible anymore to make that a reference to api.....
> I will leave the backquotes, so it will at least be made a bold font in
> the docs....
> Please let me know if somebody sees troubles with this
> Regards,
> Richard
> _______________________________________________
> 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/2026f504/attachment.sig>

More information about the Qgis-developer mailing list