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

[Tim Sutton]

Hi

> On 20 Jan 2016, at 15:26, Richard Duivenvoorde <richard at duif.net> 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

This seems ok to me - the value of knowing the docs are clean is probably higher than the value of the outward links for class references.

Regards

Tim

> 
> Regards,
> 
> Richard
> _______________________________________________
> Qgis-community-team mailing list for organizing community resources such as documentation, translation etc..
> Qgis-community-team at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/qgis-community-team

—





Tim Sutton

Visit http://kartoza.com <http://kartoza.com/> to find out about open source:

* Desktop GIS programming services
* Geospatial web development
* GIS Training
* Consulting Services

Skype: timlinux Irc: timlinux on #qgis at freenode.net
Tim is a member of the QGIS Project Steering Committee

Kartoza is a merger between Linfiniti and Afrispatial

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20160120/d4501a33/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: KartozaLogo160x66.png
Type: image/png
Size: 9324 bytes
Desc: not available
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20160120/d4501a33/attachment-0001.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 455 bytes
Desc: Message signed with OpenPGP using GPGMail
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20160120/d4501a33/attachment-0001.sig>