[GitHub] libcloud pull request #1105: [WIP] Re-enable strict checks (treat warnings a...

[Kami <gi...@git.apache.org>]

GitHub user Kami opened a pull request:

    https://github.com/apache/libcloud/pull/1105

    [WIP] Re-enable strict checks (treat warnings as errors) when building sphinx docs on Travis CI

    This pull request re-enables strict checks when building sphinx docs on Travis CI.
    
    This way we can automatically catch invalid / broken docstrings and other documentation related issues (invalid syntax) early on.
    
    #1061 disabled this and since then a bunch of broken docstring syntax got in the repo so it will take a while to fix it all so we can merge this.
    
    On a related note - I know that the PR description said "temporarily", but such things are rarely temporary so we need to be careful when merging such things. Strict checking was enabled for a reason and disabling such automatic checks is rarely a good idea - root cause should be found and fixed instead.
    
    /cc @tonybaloney 

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/Kami/libcloud re_enable_sphinx_docs_strict_checks

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/libcloud/pull/1105.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #1105
    
----
commit fe3e7c01b647513e4db389e9ab4d3020b2564605
Author: Tomaz Muraus <to...@tomaz.me>
Date:   2017-09-06T14:57:53Z

    Re-enable strict checks (treat warnings as errors) when building sphinx
    docs.
    
    This allows us to catch broken / invalid docstrings and other
    documentation related issues.

----


---

[GitHub] libcloud pull request #1105: Re-enable strict checks (treat warnings as erro...

[asfgit <gi...@git.apache.org>]

Github user asfgit closed the pull request at:

    https://github.com/apache/libcloud/pull/1105


---