Build docs on Travis

zotonic · Jan 8, 2016 · 1b9729d · 1b9729d
1 parent cff8fec
commit 1b9729d
Show file tree

Hide file tree

Showing 28 changed files with 62 additions and 48 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -3,8 +3,19 @@ otp_release:
   - 18.0
   - 17.4
   - R16B
-install: echo "hi" # stub command; otherwise travis runs 'rebar get-deps'
-script: make all edocs && make test
+
+addons:
+  apt:
+    packages:
+      - python-sphinx
+      - enchant
+
+install: make all edocs
+script:
+  - make all edocs
+  - make test
+  - make -C doc/ stubs
+  - make -C doc/ SPHINXOPTS='-nW' html
 sudo: false
 branches:
   only:

diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
-Welcome to Zotonic [![Build Status](https://secure.travis-ci.org/zotonic/zotonic.png?branch=master)](http://travis-ci.org/zotonic/zotonic)
+Welcome to Zotonic [![Build Status](https://travis-ci.org/zotonic/zotonic.svg?branch=master)](https://travis-ci.org/zotonic/zotonic)
+
 ==================
 
 [![Join the chat at https://gitter.im/zotonic/zotonic](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/zotonic/zotonic?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

diff --git a/doc/cookbook/admin-a-custom-widget.rst b/doc/cookbook/admin-a-custom-widget.rst
@@ -6,7 +6,7 @@ Creating a custom widget on the edit page
 Why
 ---
 
-For an imaginary webshop edit page, we want to add 2 more data fields: the affiliate url and a note about free shipping.
+For an imaginary webshop edit page, we want to add 2 more data fields: the affiliate URL and a note about free shipping.
 
 
 Assumptions

diff --git a/doc/cookbook/admin-datetime.rst b/doc/cookbook/admin-datetime.rst
@@ -2,7 +2,7 @@ Storing date/time fields
 ========================
 
 Some interesting tidbits about saving/updating a date/time field of a
-rsc.
+resource.
 
 Why
 ---

diff --git a/doc/cookbook/frontend-custom-content-block.rst b/doc/cookbook/frontend-custom-content-block.rst
@@ -44,7 +44,7 @@ The interesting parts are ``"Media"``, ``"Music Player"`` and
 ``music_player``. ``"Media"`` will appear as a section heading in the
 ``[+add block]`` drop down menu, below the ``Standard`` section.
 ``"Music Player"`` will appear below this, and is what the content
-editor clicks on to instert the block. The ``music_player`` atom is
+editor clicks on to insert the block. The ``music_player`` atom is
 what Zotonic uses to figure out which templates to use, they will be
 created in ``templates/blocks`` and will be called
 ``_admin_edit_block_li_music_player.tpl`` and

diff --git a/doc/dev/releasenotes/rel_0.09.0.rst b/doc/dev/releasenotes/rel_0.09.0.rst
@@ -56,7 +56,7 @@ New tags/changed tags
 {% javascript %}...{% endjavascript %}
 Adds javascript that will be run after jQuery has been initialized.
 In dynamic content it will run after the DOM has been updated with the
-template where the Javascript was defined.
+template where the JavaScript was defined.
 
 {% image %} new attribute: mediaclass. Image classes can be defined
 using property files in the template directory. Which image class

diff --git a/doc/dev/releasenotes/rel_0.12.4.rst b/doc/dev/releasenotes/rel_0.12.4.rst
@@ -31,7 +31,7 @@ Arthur Clemens (44):
 * doc: Document template models
 * doc: add icons documentation
 * doc: document 'page_url with' syntax
-* doc: document more use cases for |if
+* doc: document more use cases for ``|if``
 * doc: formatting
 * doc: remove deprecated %stream%
 * doc: restructure actions

diff --git a/doc/dev/releasenotes/rel_0.13.0.rst b/doc/dev/releasenotes/rel_0.13.0.rst
@@ -427,7 +427,7 @@ Arthur Clemens (160):
 * mod_base_site: better defaults
 * Revert "mod_video_embed: add bootstrap responsive class"
 * doc: document 'page_url with' syntax
-* doc: document more use cases for |if
+* doc: document more use cases for ``|if``
 * mod_bootstrap: version 3.3.2
 * doc: show css output when extending icons
 * validation: provide message_after param to templates

diff --git a/doc/dev/releasenotes/rel_0.13.4.rst b/doc/dev/releasenotes/rel_0.13.4.rst
@@ -58,7 +58,7 @@ Marc Worrell (16):
     *  mod_video: use the default ffmpeg command if the configured ffmpeg command is empty.
     *  mod_video: use the default ffprobe and ffmpeg_preview command if the configured command is empty.
     *  New dependencies
-    *  mod_acl_user_groups: ACL rules only apply to category 'meta' if either 'meta' or the system content group is *mentioned in the ACL rule. Fixes #1030
+    *  mod_acl_user_groups: ACL rules only apply to category 'meta' if either 'meta' or the system content group is mentioned in the ACL rule. Fixes #1030
     *  mod_l10n: added Kosovo (code xk) to the country list.
     *  mod_acl_user_groups: add 'view-only' option. Fixes #1034
     *  mod_acl_user_groups: show error if access to the ACL rules view is denied.

diff --git a/doc/dev/releasenotes/rel_0.13.5.rst b/doc/dev/releasenotes/rel_0.13.5.rst
@@ -144,6 +144,6 @@ Marc Worrell (55):
     * core: expose pivot_location_lat, pivot_location_lng and pivot_geocode_qhash as m_rsc properties.
     * core: correct identify of MS Visio files.
     * core: allow 'gray' and 'grey' for the grey image filter.
-    * core: set 'Cache-Control-Allow-Origin: *' on all controller_file replies.
+    * core: set ``Cache-Control-Allow-Origin: *`` on all controller_file replies.
     * Lock deps. Fixes a problem where the empty url was changed into '/'. Fixes #1066
 
diff --git a/doc/dev/translations.rst b/doc/dev/translations.rst
@@ -1,5 +1,3 @@
-.. _dev-contributing:
-
 Translations of source code and templates
 =========================================
 

diff --git a/doc/installation/_make_common.rst b/doc/installation/_make_common.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 2. Type ``make`` in the root of Zotonic (there where the Makefile is located).
 
 3. When the build is done, start Zotonic in debug mode::

diff --git a/doc/manuals/dispatch.rst b/doc/manuals/dispatch.rst
@@ -23,8 +23,8 @@ must be placed inside the ``dispatch/`` directory of a module or your
 site.
 
 A module or site can have multiple dispatch files, and they can have
-`any` filename. Nota bene: the file may not have the extension
-“.erl”. Otherwise it will be compiled by the Emakefile, which will
+`any` filename. The file may not have the extension
+``.erl``. Otherwise it will be compiled by the Emakefile, which will
 result in errors as a dispatch file is not a valid Erlang module.
 
 The content of a dispatch file is an Erlang list of dispatch rules.
@@ -91,7 +91,7 @@ Then when I create a URL like this::
 
   {% url rulename %}
 
-It will match the first rule (rendering the url ``/foo/bar``) because
+It will match the first rule (rendering the URL ``/foo/bar``) because
 no arguments were given. However when I add an argument::
 
   {% url rulename var=1 %}

diff --git a/doc/manuals/user/admin.rst b/doc/manuals/user/admin.rst
diff --git a/doc/ref/actions/action_confirm.rst b/doc/ref/actions/action_confirm.rst
@@ -2,15 +2,15 @@
 .. include:: meta-confirm.rst
 
 
-Show a javascript confirm message and on confirmation triggers one or more actions and/or send a postback to the server.
+Show a JavaScript confirm message and on confirmation triggers one or more actions and/or send a postback to the server.
 
 .. highlight:: django
 
 Example::
 
    {% button action={confirm text="Format hard disk?" action={growl text="Better not"}} %}
 
-Shows a javascript dialog with the question "Format hard disk?".  When this dialog is confirmed then the growl message "Better not" will appear. When the dialog is denied or canceled then nothing happens.
+Shows a JavaScript dialog with the question "Format hard disk?".  When this dialog is confirmed then the growl message "Better not" will appear. When the dialog is denied or canceled then nothing happens.
 
 .. highlight:: erlang
 

diff --git a/doc/ref/actions/predicates/index.rst b/doc/ref/actions/predicates/index.rst
@@ -6,8 +6,6 @@ Predicates and Connections
    :maxdepth: 1
    :glob:
 
-   ../action_dialog_predicate_delete
    ../action_dialog_predicate_new
    ../action_link
-   ../action_predicate_delete
    ../action_unlink
diff --git a/doc/ref/dispatch/.generate b/doc/ref/dispatch/.generate
@@ -27,7 +27,7 @@ EOF
         fi
 
         cat <<EOF - $meta >> $all
-.. _all-dispatch-$mod:
+.. _all-$base:
 :ref:\`$mod\` (:ref:\`$dispatch <dispatch-$base>\`)
 EOF
 

diff --git a/doc/ref/dispatch/index.rst b/doc/ref/dispatch/index.rst
@@ -1,3 +1,5 @@
+.. _all dispatch rules:
+
 All dispatch rules
 ==================
 

diff --git a/doc/ref/filters/html/index.rst b/doc/ref/filters/html/index.rst
@@ -9,6 +9,5 @@ HTML
    ../filter_show_media
    ../filter_striptags
    ../filter_truncate_html
-   ../filter_update_iframe
    ../filter_urlize
    ../filter_without_embedded_media
diff --git a/doc/ref/filters/resources/index.rst b/doc/ref/filters/resources/index.rst
@@ -6,5 +6,6 @@ Resources
    :maxdepth: 1
    :glob:
 
+   ../filter_admin_merge_diff
    ../filter_summary
    ../filter_temporary_rsc
diff --git a/doc/ref/filters/variables/index.rst b/doc/ref/filters/variables/index.rst
@@ -12,6 +12,7 @@ Variables
    ../filter_if_undefined
    ../filter_is_defined
    ../filter_is_undefined
+   ../filter_make_value
    ../filter_pprint
    ../filter_to_binary
    ../filter_to_integer

diff --git a/doc/ref/models/model_acl.rst b/doc/ref/models/model_acl.rst
@@ -24,12 +24,12 @@ The following m_acl model properties are available in templates:
 |is_allowed          |Perform custom ACL checks which are   |
 |                    |different from the ones mentioned.    |
 +--------------------+--------------------------------------+
-|authenticated       | Used before the other ACL checks to  |
-|                    | check if a *typical* user is allowed |
-|                    | to perform some actions. Example:    |
+|authenticated       |Used before the other ACL checks to   |
+|                    |check if a *typical* user is allowed  |
+|                    |to perform some actions. Example:     |
 |                    |``m.acl.authenticated.insert.article``|
-|                    | If an user is logged on the that     |
-|                    | user’s permissions are used.         |
+|                    |If an user is logged on the that      |
+|                    |user’s permissions are used.          |
 +--------------------+--------------------------------------+
 
 

diff --git a/doc/ref/models/model_edge.rst b/doc/ref/models/model_edge.rst
@@ -31,14 +31,21 @@ The following m_edge model properties are available in templates:
 |          |that this function returns the subject             |                            |
 |          |edges.                                             |                            |
 +----------+---------------------------------------------------+----------------------------+
-|o_props   |Similar to ``m.edge.o[id].author`` above, but      |``[[{id,86062},             |
-|          |returns a property list for the edges instead of   |  {subject_id,10635},       |
-|          |the 2-tuple.                                       |  {predicate_id,304},       |
-|          |                                                   |  {object_id,57577},        |
-|          |                                                   |  {seq,1},                  |
-|          |                                                   |  {creator_id,1},           |
-|          |                                                   |  {created,{{2015,11,17},   |
-|          |                                                   |  {11,23,32}}}]]``          |
+|o_props   |Similar to ``m.edge.o[id].author`` above, but      |.. code-block:: none        |
+|          |returns a property list for the edges instead of   |                            |
+|          |the 2-tuple.                                       |    [                       |
+|          |                                                   |        {id, 86062},        |
+|          |                                                   |        {subject_id, 10635},|
+|          |                                                   |        {predicate_id, 304},|
+|          |                                                   |        {object_id, 57577}, |
+|          |                                                   |        {seq, 1},           |
+|          |                                                   |        {creator_id, 1},    |
+|          |                                                   |        {created, {         |
+|          |                                                   |            {2015,11,17},   |
+|          |                                                   |            {11,23,32}      |
+|          |                                                   |        }}                  |
+|          |                                                   |    ]                       |
+|          |                                                   |    ]                       |
 +----------+---------------------------------------------------+----------------------------+
 |s_props   |Similar to ``m.edge.s[id].author`` above, but      |                            |
 |          |returns a property list for the edges instead of   |                            |

diff --git a/doc/ref/modules/mod_base.rst b/doc/ref/modules/mod_base.rst
@@ -2,7 +2,7 @@
 .. include:: meta-mod_base.rst
 
 mod_base is the base module, which acts as a container module holding
-most of Zotonic basic :ref:`dispatch rules <all-dispatch-mod_base>`,
+most of Zotonic basic :ref:`dispatch rules <all dispatch rules>`,
 :ref:`actions` and :ref:`scomps`.
 
 Note that the amount of `templates` has been kept to a minimum in this
@@ -12,4 +12,4 @@ want. For a standard site with commonly used templates, see the
 
 .. todo:: Add more documentation
 
-.. seealso:: :ref:`dispatch rules <all-dispatch-mod_base>`, :ref:`mod_base_site`.
+.. seealso:: :ref:`dispatch rules <all dispatch rules>`, :ref:`mod_base_site`.
diff --git a/doc/ref/modules/mod_base_site.rst b/doc/ref/modules/mod_base_site.rst
@@ -9,4 +9,4 @@ the site is also usable on simpler `text` or `phone` devices.
 
 .. todo:: Add more documentation
 
-.. seealso:: :ref:`dispatch rules <all-dispatch-mod_base_site>`, :ref:`mod_base`.
+.. seealso:: :ref:`mod_base`.
diff --git a/doc/ref/tags/tag_image.rst b/doc/ref/tags/tag_image.rst
@@ -13,7 +13,7 @@ For example::
 
    {% image "cow.jpg" width=200 height=200 crop %}
 
-This will generate an image tag for the image “cow.jpg” (in the files/archive directory) of 200x200 pixels. The image will be resized and cropped to the requested size.  The image tag will be something like (the checksum will vary per :term:`sign key`)::
+This will generate an image tag for the image “cow.jpg” (in the files/archive directory) of 200x200 pixels. The image will be resized and cropped to the requested size.  The image tag will be something like (the checksum will vary per sign key)::
 
    <img src="/image/cow.jpg%28200x200%29%28crop%29%28981E1AD8DA60381D00C094F0EE1311F5%29.jpg" width="200" height="200" />
 

diff --git a/doc/ref/tags/tag_url.rst b/doc/ref/tags/tag_url.rst
@@ -12,7 +12,7 @@ For example to generate the url to the admin for editing a :term:`page` (:term:`
 
    {% url admin_edit_rsc id=myid %}
 
-Assuming myid is 42 then this will generate (on most Zotonic sites) the url “/admin/edit/42”.  The name “admin_edit_rsc” can be found in the :ref:`dispatch-mod_admin-dispatch` rules of :ref:`mod_admin`.  Which :ref:`dispatch rules <dispatch>` are available depends on which :ref:`ref-modules` are enabled.
+Assuming myid is 42 then this will generate (on most Zotonic sites) the url “/admin/edit/42”.  The name “admin_edit_rsc” can be found in the :ref:`dispatch-mod_admin-dispatch` rules of :ref:`mod_admin`.  Which :ref:`dispatch rules <manual-dispatch>` are available depends on which :ref:`ref-modules` are enabled.
 
 When the dispatch rule named in the first argument is unknown then an empty string is returned.  There is no error message. This is to prevent breaking the web site when modules are enabled or disabled.
 

diff --git a/doc/ref/templates/index.rst b/doc/ref/templates/index.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _templates:
 
 Templates