Merge pull request #169 from ocsigen/how-ci

Automatic doc generation (html_of_wiki)

Author: balat

.howdocgen

@@ -0,0 +1,40 @@
+#!/bin/bash
+set -x
+
+LATEST=$(find doc -maxdepth 1 -type d -not -name doc -not -name dev -exec basename {} \; | sort -nr | head -n 1)
+
+wget https://raw.githubusercontent.com/ocaml/ocaml-travisci-skeleton/master/.travis-ocaml.sh
+export OCAML_VERSION=4.06
+bash -ex .travis-ocaml.sh
+
+eval $(opam env)
+
+git clone https://github.com/ocsigen/html_of_wiki.git
+opam pin add -y html_of_wiki html_of_wiki
+
+# wget https://raw.githubusercontent.com/ocsigen/ocsigen.github.io/master/template.wiki
+# TODO when every project's CI will run HOW for its docs, uncomment the line above,
+# remove the 5 following lines and `git rm' the file doc/template.wiki.
+wget https://raw.githubusercontent.com/ocsigen/ocsigen.github.io/e6b93e987b75be99e8ef30601460f60028c615fd/css/style.css
+wget https://raw.githubusercontent.com/ocsigen/ocsigen.github.io/e6b93e987b75be99e8ef30601460f60028c615fd/img/search.svg
+mkdir tmp
+mv style.css tmp
+mv search.svg tmp
+
+f=$(mktemp)
+cat >$f <<EOF
+{
+    "project": "ocsigen-toolkit",
+    "api": "api",
+    "menu": true,
+    "csw": true,
+    "templates": ["doc/template.wiki"],
+    "manual": "manual"
+}
+EOF
+quickdop -f doc _doc -t json -c $f -viu
+
+ln -s "$LATEST/manual/intro.html" _doc/index.html
+
+# TODO Also remove that line.
+mv tmp _doc

.travis.yml

@@ -0,0 +1,16 @@
+language: c
+
+install:
+    - true
+
+script:
+    - ./.howdocgen
+
+deploy:
+  provider: pages
+  keep-history: true
+  skip-cleanup: true
+  github-token: $GHP_TOKEN
+  local-dir: _doc
+  on:
+    branch: master

doc/0.99/api/client/Ot_buttons.wiki

@@ -0,0 +1,4 @@
+=Module <<a_api_type subproject="client" | module Ot_buttons >> =
+<<pre class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|module>> <<span class="ocsforge_color_uid"|<<span class="ocsforge_color_uid"|Ot_buttons>>>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="ocsforge_color_keyword"|sig>><<a_api subproject="client" text=".." | module Ot_buttons >><<span class="ocsforge_color_keyword"|end>>>>
+----
+<<pre id="VALdropdown" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|dropdown>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|\\  <<span class="ocsforge_color_label"| ?a: >><<span class="ocsforge_color_uid"|Html_types>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|div_attrib>> <<span class="ocsforge_color_uid"|Eliom_content>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Html>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|attrib>> list <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_label"| menu: >><<span class="ocsforge_color_uid"|Html_types>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|div_content>> <<span class="ocsforge_color_uid"|Eliom_content>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Html>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|elt>> list <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_uid"|Html_types>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|div_content>> <<span class="ocsforge_color_uid"|Eliom_content>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Html>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|elt>> list <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_uid"|Html_types>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|div_content>> <<span class="ocsforge_color_uid"|Eliom_content>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Html>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|elt>>>>>>

doc/0.99/api/client/Ot_calendar.wiki

@@ -0,0 +1,33 @@
+=Module <<a_api_type subproject="client" | module Ot_calendar >> =
+<<pre class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|module>> <<span class="ocsforge_color_uid"|<<span class="ocsforge_color_uid"|Ot_calendar>>>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="ocsforge_color_keyword"|sig>><<a_api subproject="client" text=".." | module Ot_calendar >><<span class="ocsforge_color_keyword"|end>>>><<span class="odocwiki_inlinecode"|intl>> is the type of internationalization specifiers~. <<span class="odocwiki_inlinecode"|i~_days>>
+    contains the names of the weekdays~, starting with
+    ~Sunday~. <<span class="odocwiki_inlinecode"|i~_months>> contains the names of the months~, starting with
+    ~January~. <<span class="odocwiki_inlinecode"|i~_start>> specifies the first day of the week~.
+
+----
+<<pre class="ocsforge_color odocwiki_code" id="TYPEintl"|<<span class="ocsforge_color_keyword"|type>> <<span class="odocwiki_name"|intl>> <<span class="ocsforge_color_delimiter"|~=>> <<span class="ocsforge_color_delimiter"|~{>>
+<<span class="odocwiki_record"|<<span class="odocwiki_field"|<<span class="odocwiki_field_descr"|  <<span class="ocsforge_color_label"|i_days:>> <<span class="odocwiki_type"|string list>><<span class="ocsforge_color_delimiter"|~;>> >>>><<span class="odocwiki_field"|<<span class="odocwiki_field_descr"|  <<span class="ocsforge_color_label"|i_months:>> <<span class="odocwiki_type"|string list>><<span class="ocsforge_color_delimiter"|~;>> >>>><<span class="odocwiki_field"|<<span class="odocwiki_field_descr"|  <<span class="ocsforge_color_label"|i_start:>> <<span class="odocwiki_type"|[ `Fri | `Mon | `Sat | `Sun | `Thu | `Tue | `Wed ]>><<span class="ocsforge_color_delimiter"|~;>> >>>>>><<span class="ocsforge_color_delimiter"|~}>>>><<pre class="ocsforge_color odocwiki_code" id="TYPEbutton_labels"|<<span class="ocsforge_color_keyword"|type>> <<span class="odocwiki_name"|button~_labels>> <<span class="ocsforge_color_delimiter"|~=>> <<span class="ocsforge_color_delimiter"|~{>>
+<<span class="odocwiki_record"|<<span class="odocwiki_field"|<<span class="odocwiki_field_descr"|  <<span class="ocsforge_color_label"|b_prev_year:>> <<span class="odocwiki_type"|string>><<span class="ocsforge_color_delimiter"|~;>> >>>><<span class="odocwiki_field"|<<span class="odocwiki_field_descr"|  <<span class="ocsforge_color_label"|b_prev_month:>> <<span class="odocwiki_type"|string>><<span class="ocsforge_color_delimiter"|~;>> >>>><<span class="odocwiki_field"|<<span class="odocwiki_field_descr"|  <<span class="ocsforge_color_label"|b_next_month:>> <<span class="odocwiki_type"|string>><<span class="ocsforge_color_delimiter"|~;>> >>>><<span class="odocwiki_field"|<<span class="odocwiki_field_descr"|  <<span class="ocsforge_color_label"|b_next_year:>> <<span class="odocwiki_type"|string>><<span class="ocsforge_color_delimiter"|~;>> >>>>>><<span class="ocsforge_color_delimiter"|~}>>>><<div class="odocwiki_info"|~An instance of <<span class="odocwiki_inlinecode"|button~_labels>> is used to customize the button
+    labels~. ~The defaults are "~<~<"~, "~<"~, "~>"~, and "~>~>"~.
+>>
+<<pre id="VALmake" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|make>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|\\  <<span class="ocsforge_color_label"| ?init: >>int * int * int <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_label"| ?highlight: >><<span class="ocsforge_color_delimiter"| ( >>int <<span class="ocsforge_color_delimiter"| -> >> int <<span class="ocsforge_color_delimiter"| -> >> int list <<span class="ocsforge_color_uid"|Lwt>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>><<span class="ocsforge_color_delimiter"| ) >> <<span class="ocsforge_color_uid"|Eliom_client_value>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_label"| ?click_non_highlighted: >>bool <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_label"| ?update: >><<span class="ocsforge_color_delimiter"| ( >>int * int * int<<span class="ocsforge_color_delimiter"| ) >> <<span class="ocsforge_color_uid"|React>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|E>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> <<span class="ocsforge_color_uid"|Eliom_client_value>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_label"| ?action: >><<span class="ocsforge_color_delimiter"| ( >>int <<span class="ocsforge_color_delimiter"| -> >> int <<span class="ocsforge_color_delimiter"| -> >> int <<span class="ocsforge_color_delimiter"| -> >> unit <<span class="ocsforge_color_uid"|Lwt>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>><<span class="ocsforge_color_delimiter"| ) >> <<span class="ocsforge_color_uid"|Eliom_client_value>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_label"| ?button_labels: >><<a_api subproject="client" text="button_labels" | type Ot_calendar.button_labels >> <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_label"| ?intl: >><<a_api subproject="client" text="intl" | type Ot_calendar.intl >> <<span class="ocsforge_color_delimiter"| -> >> unit <<span class="ocsforge_color_delimiter"| -> >> [> `Table ] <<span class="ocsforge_color_uid"|Eliom_content>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Html>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|elt>>>>>><<div class="odocwiki_info"|<<span class="odocwiki_inlinecode"|make ~?highlight ~?click~_any ~?action>> produces a calendar~.
+
+
+    ~If a client~-side function <<span class="odocwiki_inlinecode"|highlight>> is provided~, <<span class="odocwiki_inlinecode"|highlight y m>>
+    needs to produce the list of days for the month <<span class="odocwiki_inlinecode"|m>> of the year
+    <<span class="odocwiki_inlinecode"|y>> that need to be visually denoted~.
+
+
+    ~If <<span class="odocwiki_inlinecode"|click~_non~_highlighted>> is <<span class="odocwiki_inlinecode"|true>>~, every date is clickable~;
+    otherwise~, only the dates that <<span class="odocwiki_inlinecode"|highlight>> returns ~(if <<span class="odocwiki_inlinecode"|highlight>>
+    is provided~) are clickable~.
+
+
+    ~If a client~-side function <<span class="odocwiki_inlinecode"|action>> is provided~, when the user
+    clicks on the date <<span class="odocwiki_inlinecode"|d>>~:<<span class="odocwiki_inlinecode"|m>>~:<<span class="odocwiki_inlinecode"|y>>~, <<span class="odocwiki_inlinecode"|action y m d>> is called~.
+>>
+<<pre id="VALmake_date_picker" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|make~_date~_picker>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|\\  <<span class="ocsforge_color_label"| ?init: >>int * int * int <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_label"| ?update: >><<span class="ocsforge_color_delimiter"| ( >>int * int * int<<span class="ocsforge_color_delimiter"| ) >> <<span class="ocsforge_color_uid"|React>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|E>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> <<span class="ocsforge_color_uid"|Eliom_client_value>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_label"| ?button_labels: >><<a_api subproject="client" text="button_labels" | type Ot_calendar.button_labels >> <<span class="ocsforge_color_delimiter"| -> >>\\  <<span class="ocsforge_color_label"| ?intl: >><<a_api subproject="client" text="intl" | type Ot_calendar.intl >> <<span class="ocsforge_color_delimiter"| -> >>\\  unit <<span class="ocsforge_color_delimiter"| -> >>\\  [> `Table ] <<span class="ocsforge_color_uid"|Eliom_content>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Html>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|elt>> *\\  <<span class="ocsforge_color_delimiter"| ( >>int * int * int<<span class="ocsforge_color_delimiter"| ) >> <<span class="ocsforge_color_uid"|Eliom_shared>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|React>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|S>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>>>>>><<div class="odocwiki_info"|<<span class="odocwiki_inlinecode"|make~_date~_picker ~?init ~(~)>> returns a client~-side reactive signal
+    <<span class="odocwiki_inlinecode"|~(y~, m~, d~)>> corresponding to the date <<span class="odocwiki_inlinecode"|d>>~:<<span class="odocwiki_inlinecode"|m>>~:<<span class="odocwiki_inlinecode"|y>> that the user
+    clicks on~. ~The optional parameter <<span class="odocwiki_inlinecode"|init>> provides an initial value
+    for the signal~.
+>>