[book] several fixes in the rst files
authorDavid Douard <david.douard@logilab.fr>
Thu, 28 Aug 2014 18:52:41 +0200
changeset 10022 927a795bb380
parent 10021 cf445c8e4b03
child 10023 c3ab46842b2d
[book] several fixes in the rst files - prevent duplicate markup definitions, - use existing Workflow markup instead of redefining one (in baseschema.rst) - include dataimport - fix non-existant directive autodocfunction - remove the empty 'embedding.rst' file
doc/book/en/admin/setup.rst
doc/book/en/devrepo/datamodel/baseschema.rst
doc/book/en/devrepo/index.rst
doc/book/en/devweb/views/embedding.rst
doc/book/en/tutorials/textreports/index.rst
--- a/doc/book/en/admin/setup.rst	Thu Aug 28 18:46:41 2014 +0200
+++ b/doc/book/en/admin/setup.rst	Thu Aug 28 18:52:41 2014 +0200
@@ -139,7 +139,7 @@
 .. _`virtualenv`: http://virtualenv.openplans.org/
 
 A working compilation chain is needed to build the modules that include C
-extensions. If you really do not want to compile anything, installing `Lxml <http://lxml.de/>`_,
+extensions. If you really do not want to compile anything, installing `lxml <http://lxml.de/>`_,
 `Twisted Web <http://twistedmatrix.com/trac/wiki/Downloads/>`_ and `libgecode
 <http://www.gecode.org/>`_ will help.
 
@@ -152,13 +152,15 @@
   apt-get install gcc python-pip python-dev libxslt1-dev libxml2-dev
 
 For Windows, you can install pre-built packages (possible `source
-<http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_). For a minimal setup, install
-`pip <http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip>`_, `setuptools
-<http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools>`_, `libxml-python
-<http://www.lfd.uci.edu/~gohlke/pythonlibs/#libxml-python>`_, `lxml
-<http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml>`_ and `twisted
-<http://www.lfd.uci.edu/~gohlke/pythonlibs/#twisted>`_ from this source making
-sure to choose the correct architecture and version of Python.
+<http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_). For a minimal setup, install:
+
+- pip http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip
+- setuptools http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools
+- libxml-python http://www.lfd.uci.edu/~gohlke/pythonlibs/#libxml-python>
+- lxml http://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml and
+- twisted http://www.lfd.uci.edu/~gohlke/pythonlibs/#twisted
+
+Make sure to choose the correct architecture and version of Python.
 
 Finally, install |cubicweb| and its dependencies, by running::
 
--- a/doc/book/en/devrepo/datamodel/baseschema.rst	Thu Aug 28 18:46:41 2014 +0200
+++ b/doc/book/en/devrepo/datamodel/baseschema.rst	Thu Aug 28 18:52:41 2014 +0200
@@ -22,7 +22,7 @@
 
 Entity types used to manage workflows
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-* _`Workflow`, workflow entity, linked to some entity types which may use this workflow
+* :ref:`Workflow <Workflow>`, workflow entity, linked to some entity types which may use this workflow
 * _`State`, workflow state
 * _`Transition`, workflow transition
 * _`TrInfo`, record of a transition trafic for an entity
--- a/doc/book/en/devrepo/index.rst	Thu Aug 28 18:46:41 2014 +0200
+++ b/doc/book/en/devrepo/index.rst	Thu Aug 28 18:52:41 2014 +0200
@@ -22,4 +22,4 @@
    migration.rst
    profiling.rst
    fti.rst
-
+   dataimport
--- a/doc/book/en/devweb/views/embedding.rst	Thu Aug 28 18:46:41 2014 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,9 +0,0 @@
-.. -*- coding: utf-8 -*-
-
-Embedding external pages
-------------------------
-
-(:mod:`cubicweb.web.views.embedding`)
-
-including external content
-
--- a/doc/book/en/tutorials/textreports/index.rst	Thu Aug 28 18:46:41 2014 +0200
+++ b/doc/book/en/tutorials/textreports/index.rst	Thu Aug 28 18:52:41 2014 +0200
@@ -8,6 +8,6 @@
 
 Three additional restructuredtext roles are defined by |cubicweb|:
 
-.. autodocfunction:: cubicweb.ext.rest.eid_reference_role
-.. autodocfunction:: cubicweb.ext.rest.rql_role
-.. autodocfunction:: cubicweb.ext.rest.bookmark_role
+.. autofunction:: cubicweb.ext.rest.eid_reference_role
+.. autofunction:: cubicweb.ext.rest.rql_role
+.. autofunction:: cubicweb.ext.rest.bookmark_role