# HG changeset patch # User Julien Cristau # Date 1435071880 -7200 # Node ID 5bd914ebf3ae40e0f14f827a3e0a65d411b37667 # Parent b6f00889355ceb95802239a6e51f1a727044ab00 [doc] fix warnings/errors in doc build - fix links to images - fix a couple of typos - re-add IDownloadableOneLineView doc - rename documenting.rst back to .txt, it's intended as a doc of how to write rst, not part of the rst doc Related to #4832808 diff -r b6f00889355c -r 5bd914ebf3ae doc/api/dataimport.rst --- a/doc/api/dataimport.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/api/dataimport.rst Tue Jun 23 17:04:40 2015 +0200 @@ -35,7 +35,7 @@ ------------------- .. autofunction:: check_doubles - .. autofunction:: check_doubles_not_one + .. autofunction:: check_doubles_not_none Object Stores ------------- diff -r b6f00889355c -r 5bd914ebf3ae doc/book/admin/site-config.rst --- a/doc/book/admin/site-config.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/admin/site-config.rst Tue Jun 23 17:04:40 2015 +0200 @@ -3,7 +3,7 @@ User interface for web site configuration ========================================= -.. image:: ../images/lax-book_03-site-config-panel_en.png +.. image:: ../../images/lax-book_03-site-config-panel_en.png This panel allows you to configure the appearance of your instance site. Six menus are available and we will go through each of them to explain how diff -r b6f00889355c -r 5bd914ebf3ae doc/book/devrepo/datamodel/define-workflows.rst --- a/doc/book/devrepo/datamodel/define-workflows.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/devrepo/datamodel/define-workflows.rst Tue Jun 23 17:04:40 2015 +0200 @@ -129,7 +129,7 @@ * `U`, the user executing that may pass the transition -.. image:: ../../images/03-transitions-view_en.png +.. image:: ../../../images/03-transitions-view_en.png You can notice that in the action box of a BlogEntry, the state is now listed as well as the possible transitions for the current state diff -r b6f00889355c -r 5bd914ebf3ae doc/book/devrepo/testing.rst --- a/doc/book/devrepo/testing.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/devrepo/testing.rst Tue Jun 23 17:04:40 2015 +0200 @@ -451,7 +451,7 @@ What you need to know about request and session ----------------------------------------------- -.. image:: ../images/request_session.png +.. image:: ../../images/request_session.png First, remember to think that some code run on a client side, some other on the repository side. More precisely: diff -r b6f00889355c -r 5bd914ebf3ae doc/book/devweb/facets.rst --- a/doc/book/devweb/facets.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/devweb/facets.rst Tue Jun 23 17:04:40 2015 +0200 @@ -8,7 +8,7 @@ Here is an exemple of the facets rendering picked from our http://www.cubicweb.org web site: -.. image:: ../images/facet_overview.png +.. image:: ../../images/facet_overview.png Facets will appear on each page presenting more than one entity that may be filtered according to some known criteria. diff -r b6f00889355c -r 5bd914ebf3ae doc/book/devweb/js.rst --- a/doc/book/devweb/js.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/devweb/js.rst Tue Jun 23 17:04:40 2015 +0200 @@ -355,7 +355,7 @@ .. toctree:: :maxdepth: 1 - js_api/index + /js_api/index Testing javascript diff -r b6f00889355c -r 5bd914ebf3ae doc/book/devweb/views/basetemplates.rst --- a/doc/book/devweb/views/basetemplates.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/devweb/views/basetemplates.rst Tue Jun 23 17:04:40 2015 +0200 @@ -60,7 +60,7 @@ A page is composed as indicated on the schema below : -.. image:: ../../images/main_template.png +.. image:: ../../../images/main_template.png The sections dispatches specific views: diff -r b6f00889355c -r 5bd914ebf3ae doc/book/devweb/views/breadcrumbs.rst --- a/doc/book/devweb/views/breadcrumbs.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/devweb/views/breadcrumbs.rst Tue Jun 23 17:04:40 2015 +0200 @@ -16,7 +16,7 @@ Here is the header section of the CubicWeb's forge: -.. image:: ../../images/breadcrumbs_header.png +.. image:: ../../../images/breadcrumbs_header.png There are three breadcrumbs components defined in :mod:`cubicweb.web.views.ibreadcrumbs`: diff -r b6f00889355c -r 5bd914ebf3ae doc/book/devweb/views/idownloadable.rst --- a/doc/book/devweb/views/idownloadable.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/devweb/views/idownloadable.rst Tue Jun 23 17:04:40 2015 +0200 @@ -14,6 +14,7 @@ .. autoclass:: cubicweb.web.views.idownloadable.DownloadView .. autoclass:: cubicweb.web.views.idownloadable.DownloadLinkView .. autoclass:: cubicweb.web.views.idownloadable.IDownloadablePrimaryView +.. autoclass:: cubicweb.web.views.idownloadable.IDownloadableOneLineView Embedded views -------------- diff -r b6f00889355c -r 5bd914ebf3ae doc/book/devweb/views/primary.rst --- a/doc/book/devweb/views/primary.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/devweb/views/primary.rst Tue Jun 23 17:04:40 2015 +0200 @@ -22,7 +22,7 @@ The primary view has the following layout. -.. image:: ../../images/primaryview_template.png +.. image:: ../../../images/primaryview_template.png .. _primary_view_configuration: @@ -198,7 +198,7 @@ The view method ``self.w()`` is used to output data. Here `lines 08-09` output HTML for the publication date of the entry. -.. image:: ../../images/lax-book_09-new-view-blogentry_en.png +.. image:: ../../../images/lax-book_09-new-view-blogentry_en.png :alt: blog entries now look much nicer Let us now improve the primary view of a blog @@ -271,6 +271,6 @@ Assuming we added entries to the blog titled `MyLife`, displaying it now allows to read its description and all its entries. -.. image:: ../../images/lax-book_10-blog-with-two-entries_en.png +.. image:: ../../../images/lax-book_10-blog-with-two-entries_en.png :alt: a blog and all its entries diff -r b6f00889355c -r 5bd914ebf3ae doc/book/devweb/views/table.rst --- a/doc/book/devweb/views/table.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/devweb/views/table.rst Tue Jun 23 17:04:40 2015 +0200 @@ -45,14 +45,14 @@ The previous example results in: -.. image:: ../../images/views-table-shadow.png +.. image:: ../../../images/views-table-shadow.png In order to activate table filter mechanism, the `display_filter` option is given as a layout argument. A small arrow will be displayed at the table's top right corner. Clicking on `show filter form` action, will display the filter form as below: -.. image:: ../../images/views-table-filter-shadow.png +.. image:: ../../../images/views-table-filter-shadow.png By the same way, you can display additional actions for the selected entities by setting `add_view_actions` layout option to `True`. This will add actions diff -r b6f00889355c -r 5bd914ebf3ae doc/book/intro/concepts.rst --- a/doc/book/intro/concepts.rst Thu Jan 08 23:00:56 2015 +0100 +++ b/doc/book/intro/concepts.rst Tue Jun 23 17:04:40 2015 +0200 @@ -54,7 +54,7 @@ repository. For applications that support high traffic, several web (front-end) and data (back-end) instances can be set-up to share the load. -.. image:: ../images/archi_globale_en.png +.. image:: ../../images/archi_globale_en.png The command :command:`cubicweb-ctl list` also displays the list of instances installed on your system. diff -r b6f00889355c -r 5bd914ebf3ae doc/dev/documenting.rst --- a/doc/dev/documenting.rst Thu Jan 08 23:00:56 2015 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,85 +0,0 @@ -==== -Book -==== - ----- -Part ----- - -Chapter -======= - -.. _Level1AnchorForLaterReference: - -Level 1 section ---------------- - -Level 2 section -~~~~~~~~~~~~~~~ - -Level 3 section -``````````````` - - - -*CubicWeb* - - -inline directives: - :file:`directory/file` - :envvar:`AN_ENV_VARIABLE` - :command:`command --option arguments` - - :ref:, :mod: - - -.. sourcecode:: python - - class SomePythonCode: - ... - -.. XXX a comment, wont be rendered - - -a [foot note]_ - -.. [foot note] the foot note content - - -Boxes -===== - -- warning box: - .. warning:: - - Warning content -- note box: - .. note:: - - Note content - - - -Cross references -================ - -To arbitrary section --------------------- - -:ref:`identifier` ou :ref:`label ` - -Label required of referencing node which as no title, else the node's title will be used. - - -To API objects --------------- -See the autodoc sphinx extension documentation. Quick overview: - -* ref to a class: :class:`cubicweb.devtools.testlib.AutomaticWebTest` - -* if you can to see only the class name in the generated documentation, add a ~: - :class:`~cubicweb.devtools.testlib.AutomaticWebTest` - -* you can also use :mod: (module), :exc: (exception), :func: (function), :meth: (method)... - -* syntax explained above to specify label explicitly may also be used diff -r b6f00889355c -r 5bd914ebf3ae doc/dev/documenting.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/dev/documenting.txt Tue Jun 23 17:04:40 2015 +0200 @@ -0,0 +1,85 @@ +==== +Book +==== + +---- +Part +---- + +Chapter +======= + +.. _Level1AnchorForLaterReference: + +Level 1 section +--------------- + +Level 2 section +~~~~~~~~~~~~~~~ + +Level 3 section +``````````````` + + + +*CubicWeb* + + +inline directives: + :file:`directory/file` + :envvar:`AN_ENV_VARIABLE` + :command:`command --option arguments` + + :ref:, :mod: + + +.. sourcecode:: python + + class SomePythonCode: + ... + +.. XXX a comment, wont be rendered + + +a [foot note]_ + +.. [foot note] the foot note content + + +Boxes +===== + +- warning box: + .. warning:: + + Warning content +- note box: + .. note:: + + Note content + + + +Cross references +================ + +To arbitrary section +-------------------- + +:ref:`identifier` ou :ref:`label ` + +Label required of referencing node which as no title, else the node's title will be used. + + +To API objects +-------------- +See the autodoc sphinx extension documentation. Quick overview: + +* ref to a class: :class:`cubicweb.devtools.testlib.AutomaticWebTest` + +* if you can to see only the class name in the generated documentation, add a ~: + :class:`~cubicweb.devtools.testlib.AutomaticWebTest` + +* you can also use :mod: (module), :exc: (exception), :func: (function), :meth: (method)... + +* syntax explained above to specify label explicitly may also be used diff -r b6f00889355c -r 5bd914ebf3ae web/facet.py --- a/web/facet.py Thu Jan 08 23:00:56 2015 +0100 +++ b/web/facet.py Tue Jun 23 17:04:40 2015 +0200 @@ -1210,7 +1210,7 @@ The image below display the rendering of the slider: - .. image:: ../images/facet_range.png + .. image:: ../../images/facet_range.png .. _jquery: http://www.jqueryui.com/ """ @@ -1309,7 +1309,7 @@ The image below display the rendering of the slider for a date range: - .. image:: ../images/facet_date_range.png + .. image:: ../../images/facet_date_range.png """ target_attr_type = 'Date' # only date types are supported @@ -1440,7 +1440,7 @@ Here is an example of the rendering of thos facet to filter book with image and the corresponding code: - .. image:: ../images/facet_has_image.png + .. image:: ../../images/facet_has_image.png .. sourcecode:: python