geopython / pywps

PyWPS is an implementation of the Web Processing Service standard from the Open Geospatial Consortium. PyWPS is written in Python.
https://pywps.org
MIT License
178 stars 117 forks source link

ext_autodoc: support RST anonymous link #542

Closed tlvu closed 4 years ago

tlvu commented 4 years ago

Overview

Sphinx "Duplicate explicit target name" warning is problematic when warning are turned into errors (sphinx-build -W).

And we would want warnings to turn into error because autodoc import failure are treated as warnings only, resulting into silent documentation build failure if those warnings do not fail the build.

Related Issue / Discussion

See PR https://github.com/bird-house/cookiecutter-birdhouse/pull/96 with the silent doc build error.

See commit https://github.com/bird-house/flyingpigeon/pull/336/commits/c97ebca73792c1fb0c32d7b6079385fcd84a73b0 and https://github.com/bird-house/emu/commit/cfcaedf0804cf3473d1c77dcd47d9303960418ff for actual real usage of this change.

Additional Information

Contribution Agreement

(as per https://github.com/geopython/pywps/blob/master/CONTRIBUTING.rst#contributions-and-licensing)

tlvu commented 4 years ago

This change is used in https://github.com/bird-house/flyingpigeon/pull/336

coveralls commented 4 years ago

Coverage Status

Coverage increased (+0.4%) to 75.589% when pulling 2a55b6e95f51c648dc94bf3c89db7370b56c1c9c on Ouranosinc:autodoc-anonymous-link-support into 532a349b1fdfd1f68a41736cad4f6822511e7796 on geopython:pywps-4.2.

tlvu commented 4 years ago

Ping @cehbrecht @huard

tlvu commented 4 years ago

Note to the person merging this PR, please do not use squash merge.

Squash merge will not merge the original commit and I have referenced the original commit in https://github.com/bird-house/flyingpigeon/blob/baf953244dee562b04b966dfb309987ed0ab588d/Makefile#L57 and in https://github.com/bird-house/emu/blob/3620ae99c5c5edb735e8b53e3bd0c1f0c650dd23/Makefile#L75

Alternatively please give me write access to https://github.com/geopython/pywps and I'll merge this PR myself, after approval or other required change of course.

cehbrecht commented 4 years ago

Note to the person merging this PR, please do not use squash merge.

Squash merge will not merge the original commit and I have referenced the original commit in https://github.com/bird-house/flyingpigeon/blob/baf953244dee562b04b966dfb309987ed0ab588d/Makefile#L57 and in https://github.com/bird-house/emu/blob/3620ae99c5c5edb735e8b53e3bd0c1f0c650dd23/Makefile#L75

Alternatively please give me write access to https://github.com/geopython/pywps and I'll merge this PR myself, after approval or other required change of course.

@tlvu I have given you write access as a contributor. Lets wait for feedback by @tomkralidis and @jachym.

cehbrecht commented 4 years ago

@tlvu feel free to merge :) I can make a patch release afterwards.