[documentation] fix some ReST compilation problems
authorAdrien Di Mascio <Adrien.DiMascio@logilab.fr>
Tue, 24 Jul 2012 17:51:00 +0200
changeset 8496 e4d71fc0b701
parent 8495 0bc63e46bdb5
child 8505 dcd9bc1d1bca
[documentation] fix some ReST compilation problems
devtools/testlib.py
doc/book/en/devweb/views/index.rst
doc/book/en/devweb/views/views.rst
doc/book/en/tutorials/advanced/part04_ui-base.rst
predicates.py
server/hook.py
web/request.py
web/views/ajaxcontroller.py
--- a/devtools/testlib.py	Tue Jul 24 15:06:55 2012 +0200
+++ b/devtools/testlib.py	Tue Jul 24 17:51:00 2012 +0200
@@ -476,6 +476,7 @@
         * using positional argument(s):
 
           .. sourcecode:: python
+
                 rdef = self.schema['CWUser'].rdef('login')
                 with self.temporary_permissions((rdef, {'read': ()})):
                     ...
@@ -484,6 +485,7 @@
         * using named argument(s):
 
           .. sourcecode:: python
+
                 rdef = self.schema['CWUser'].rdef('login')
                 with self.temporary_permissions(CWUser={'read': ()}):
                     ...
--- a/doc/book/en/devweb/views/index.rst	Tue Jul 24 15:06:55 2012 +0200
+++ b/doc/book/en/devweb/views/index.rst	Tue Jul 24 17:51:00 2012 +0200
@@ -18,10 +18,10 @@
    boxes
    table
    xmlrss
-..   editforms
    urlpublish
    breadcrumbs
    idownloadable
    wdoc
+..   editforms
 ..   embedding
 
--- a/doc/book/en/devweb/views/views.rst	Tue Jul 24 15:06:55 2012 +0200
+++ b/doc/book/en/devweb/views/views.rst	Tue Jul 24 17:51:00 2012 +0200
@@ -65,7 +65,7 @@
 
 Other basic view classes
 ````````````````````````
-Here are some of the subclasses of :ref:`View` defined in :ref:`cubicweb.view`
+Here are some of the subclasses of :class:`~cubicweb.view.View` defined in :mod:`cubicweb.view`
 that are more concrete as they relate to data rendering within the application:
 
 .. autoclass:: cubicweb.view.EntityView
--- a/doc/book/en/tutorials/advanced/part04_ui-base.rst	Tue Jul 24 15:06:55 2012 +0200
+++ b/doc/book/en/tutorials/advanced/part04_ui-base.rst	Tue Jul 24 17:51:00 2012 +0200
@@ -294,6 +294,7 @@
 folder in which the current file (e.g. `self.entity`) is located.
 
 .. Note::
+
    The :class:`IBreadCrumbs` interface is a `breadcrumbs` method, but the default
    :class:`IBreadCrumbsAdapter` provides a default implementation for it that will look
    at the value returned by its `parent_entity` method. It also provides a
@@ -331,6 +332,7 @@
 navigate through the web site to see if everything is ok...
 
 .. Note::
+
    In the 'cubicweb-ctl i18ncube' command, `sytweb` refers to the **cube**, while
    in the two other, it refers to the **instance** (if you can't see the
    difference, reread CubicWeb's concept chapter !).
@@ -363,4 +365,4 @@
 .. _`several improvments`: http://www.cubicweb.org/blogentry/1179899
 .. _`3.8`: http://www.cubicweb.org/blogentry/917107
 .. _`first blog of this series`: http://www.cubicweb.org/blogentry/824642
-.. _`an earlier post`: http://www.cubicweb.org/867464
\ No newline at end of file
+.. _`an earlier post`: http://www.cubicweb.org/867464
--- a/predicates.py	Tue Jul 24 15:06:55 2012 +0200
+++ b/predicates.py	Tue Jul 24 17:51:00 2012 +0200
@@ -737,12 +737,16 @@
     See :class:`~cubicweb.predicates.EClassPredicate` documentation for entity
     class lookup / score rules according to the input context.
 
-    .. note:: when interface is an entity class, the score will reflect class
-              proximity so the most specific object will be selected.
+    .. note::
+
+       when interface is an entity class, the score will reflect class
+       proximity so the most specific object will be selected.
 
-    .. note:: deprecated in cubicweb >= 3.9, use either
-              :class:`~cubicweb.predicates.is_instance` or
-              :class:`~cubicweb.predicates.adaptable`.
+    .. note::
+
+       deprecated in cubicweb >= 3.9, use either
+       :class:`~cubicweb.predicates.is_instance` or
+       :class:`~cubicweb.predicates.adaptable`.
     """
 
     def __init__(self, *expected_ifaces, **kwargs):
--- a/server/hook.py	Tue Jul 24 15:06:55 2012 +0200
+++ b/server/hook.py	Tue Jul 24 17:51:00 2012 +0200
@@ -237,7 +237,7 @@
 
 
 Hooks specific predicate
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 .. autoclass:: cubicweb.server.hook.match_rtype
 .. autoclass:: cubicweb.server.hook.match_rtype_sets
 
--- a/web/request.py	Tue Jul 24 15:06:55 2012 +0200
+++ b/web/request.py	Tue Jul 24 17:51:00 2012 +0200
@@ -96,9 +96,9 @@
         super(CubicWebRequestBase, self).__init__(vreg)
         #: (Boolean) Is this an https request.
         self.https = https
-        #: User interface property (vary with https) (see uiprops_)
+        #: User interface property (vary with https) (see :ref:`uiprops`)
         self.uiprops = None
-        #: url for serving datadir (vary with https) (see resources_)
+        #: url for serving datadir (vary with https) (see :ref:`resources`)
         self.datadir_url = None
         if https:
             self.uiprops = vreg.config.https_uiprops
@@ -171,7 +171,7 @@
     def authmode(self):
         """Authentification mode of the instance
 
-        (see `Configuring the Web server`_)"""
+        (see :ref:`Configuring the Web server`)"""
         return self.vreg.config['auth-mode']
 
     # Various variable generator.
--- a/web/views/ajaxcontroller.py	Tue Jul 24 15:06:55 2012 +0200
+++ b/web/views/ajaxcontroller.py	Tue Jul 24 17:51:00 2012 +0200
@@ -28,7 +28,7 @@
 functions that can be called from the javascript world.
 
 To register a new remote function, either decorate your function
-with the :ref:`cubicweb.web.views.ajaxcontroller.ajaxfunc` decorator:
+with the :func:`~cubicweb.web.views.ajaxcontroller.ajaxfunc` decorator:
 
 .. sourcecode:: python
 
@@ -39,7 +39,7 @@
     def list_users(self):
         return [u for (u,) in self._cw.execute('Any L WHERE U login L')]
 
-or inherit from :class:`cubicwbe.web.views.ajaxcontroller.AjaxFunction` and
+or inherit from :class:`~cubicweb.web.views.ajaxcontroller.AjaxFunction` and
 implement the ``__call__`` method:
 
 .. sourcecode:: python