Fix Sphinx warnings and build with '-W'

valum-framework · Feb 7, 2016 · 01882fc · 01882fc
1 parent 487fbcb
commit 01882fc
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 18 deletions.
diff --git a/docs/_static/.gitignore b/docs/_static/.gitignore
diff --git a/docs/about/gnu-lgpl-v3.0.rst b/docs/about/gnu-lgpl-v3.0.rst
@@ -58,12 +58,12 @@ facility is invoked), then you may convey a copy of the modified
 version:
 
 * **a)** under this License, provided that you make a good faith effort to
-ensure that, in the event an Application does not supply the
-function or data, the facility still operates, and performs
-whatever part of its purpose remains meaningful, or
+         ensure that, in the event an Application does not supply the
+         function or data, the facility still operates, and performs
+         whatever part of its purpose remains meaningful, or
 
 * **b)** under the GNU GPL, with none of the additional permissions of
-this License applicable to that copy.
+         this License applicable to that copy.
 
 ### 3. Object Code Incorporating Material from Library Header Files
 
@@ -75,10 +75,10 @@ layouts and accessors, or small macros, inline functions and templates
 (ten or fewer lines in length), you do both of the following:
 
 * **a)** Give prominent notice with each copy of the object code that the
-Library is used in it and that the Library and its use are
-covered by this License.
+         Library is used in it and that the Library and its use are
+         covered by this License.
 * **b)** Accompany the object code with a copy of the GNU GPL and this license
-document.
+         document.
 
 4. Combined Works
 ~~~~~~~~~~~~~~~~~

diff --git a/docs/getting-started.rst b/docs/getting-started.rst
@@ -108,7 +108,7 @@ Running the example
 VSGI produces process-based applications that are either self-hosted or able to
 communicate with a HTTP server according to a standardized protocol.
 
-The :doc:`vsgi/http/soup` implementation is self-hosting, so you just have to
+The :doc:`vsgi/server/http` implementation is self-hosting, so you just have to
 run it and point your browser at http://127.0.0.1:3003 to see the result.
 
 .. code-block:: bash

diff --git a/docs/hacking.rst b/docs/hacking.rst
@@ -52,7 +52,7 @@ spending time on producing a body that won't be considered is important.
         return;
     }
 
-    res.body.write_all ("<!DOCTYPE html><html>...</html>");
+    res.body.write_all ("<!DOCTYPE html><html></html>");
 
 Use the ``construct`` block to perform post-initialization work. It will be
 called independently of how the object is constructed.

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,11 +1,15 @@
 Valum web micro-framework
 =========================
 
-.. image:: https://travis-ci.org/valum-framework/valum.svg?branch=master
-    :target: https://travis-ci.org/valum-framework/valum
+.. raw:: html
 
-.. image:: https://coveralls.io/repos/valum-framework/valum/badge.svg?branch=master
-    :target: https://coveralls.io/r/valum-framework/valum?branch=master
+    <a href="https://travis-ci.org/valum-framework/valum">
+        <img src="https://travis-ci.org/valum-framework/valum.svg?branch=master">
+    </a>
+
+    <a href="https://coveralls.io/repos/valum-framework/valum/badge.svg?branch=master">
+        <img src="https://coveralls.io/r/valum-framework/valum?branch=master">
+    </a>
 
 Valum is a web micro-framework written in Vala and licensed under the LGPLv3.
 Its source code and releases are available on GitHub: `valum-framework/valum`_.

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -161,7 +161,7 @@ Run the sample application
 
 You can run the sample application from the ``build`` folder if you called
 ``./waf configure`` with the ``--enable-examples`` flag, it uses the
-:doc:`vsgi/server/soup`.
+:doc:`vsgi/server/http`.
 
 .. code-block:: bash
 

diff --git a/docs/router.rst b/docs/router.rst
@@ -193,6 +193,8 @@ accordingly. Similarly to status codes, errors are propagated in the
 ``HandlerCallback`` and ``NextCallback`` delegate signatures and can be handled
 with a ``500`` handler.
 
+.. _GLib.Error: http://valadoc.org/#!api=glib-2.0/GLib.Error
+
 It provides a nice way to ignore passively unrecoverable errors.
 
 .. code:: vala
@@ -210,6 +212,7 @@ It provides a nice way to ignore passively unrecoverable errors.
             });
         });
     });
+
 If the routing context is lost, any operation can still be performed within
 ``Router.invoke``
 

diff --git a/docs/vsgi/connection.rst b/docs/vsgi/connection.rst
@@ -17,7 +17,7 @@ output stream of the used technology.
 .. _GLib.IOStream: http://valadoc.org/#!api=gio-2.0/GLib.IOStream
 
 The following example shows how to bypass processing with higher-level
-abstractions. It will only work on :doc:`server/soup`, as CGI-like protocols
+abstractions. It will only work on :doc:`server/http`, as CGI-like protocols
 require the status to be part of the response headers.
 
 .. code::

diff --git a/docs/wscript b/docs/wscript
@@ -7,6 +7,6 @@ def build(bld):
     if bld.env.SPHINXBUILD:
         bld.load('gnu_dirs')
         bld(
-            rule         = '${SPHINXBUILD} -b html ../docs ${TGT}',
-            target       = '.',
-            source       = bld.path.ant_glob('*.rst') + bld.path.ant_glob('**/*.rst'))
+            rule   = '${SPHINXBUILD} -W -b html ../docs ${TGT}',
+            target = '.',
+            source = bld.path.ant_glob('*.rst') + bld.path.ant_glob('**/*.rst'))