ext_autodoc: support RST anonymous link #542
Conversation
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. See PR bird-house/cookiecutter-birdhouse#96 with the silent doc build error.
|
This change is used in bird-house/flyingpigeon#336 |
|
Ping @cehbrecht @huard |
| @@ -8,6 +8,21 @@ | |||
| from pywps.app.Common import Metadata | |||
|
|
|||
|
|
|||
| class MetadataUrl(Metadata): | |||
There was a problem hiding this comment.
I would add the anonymous option to the Metadata class itself instead of sub-classing it. What do you think?
There was a problem hiding this comment.
That was my initial thought until I saw how the Metadata class is being used. It's being used to generate the xml response, it can be serialized to and deserialized from json format. So bigger impact and not required for what I needed to solve.
So I am unsure if adding the new anonymous option there is appropriate.
But it's my first pywps commit so I will follow you guidance. Let me know if adding it to the Metadata is the right thing to do.
There was a problem hiding this comment.
@tomkralidis What is your opinion?
|
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. |
|
@tlvu feel free to merge :) I can make a patch release afterwards. |
…ust-doc-build Refresh cookiecutter for more robust doc build. This PR applies the cookiecutter PR bird-house/cookiecutter-birdhouse#96 to ensure no silent ReadTheDocs build failure and for Travis-CI to also catch ReadTheDocs build failure before PR is merged. Successful RtD generation: https://emu.readthedocs.io/en/test-rtd-build/ and matching RtD build logs: https://readthedocs.org/api/v2/build/11555381.txt Changes: * Turn RtD warnings to build failure so they do not fail silently. * Change Travis-CI build config to also build Epub and Latex doc format to catch RtD failure on Travis-CI before PR is merged. * Various changes to remove all warnings in doc build since warnings will now fail the doc build. * For doc build only, to work-around warnings, use a new PYWPS release to support RST anonymous links, currently installing PYWPS from source (with commit hash locked so it is reproducible) since no release yet (PR geopython/pywps#542) * Anaconda build badge do not exist anymore so it had to be removed. Unrelated changes part of this PR (sorry !): * Other cookiecutter changes that are unapplied previously are also part of this PR. You might want to look at each commit to avoid the noises.
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 bird-house/cookiecutter-birdhouse#96 with the silent doc build error.
See commit bird-house/flyingpigeon@c97ebca and bird-house/emu@cfcaedf 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)