~abreu-alexandre/ubuntu-html5-theme/oxide-backport-14.04

« back to all changes in this revision

Viewing changes to 0.1/ambiance/js/DOCSREADME.txt

  • Committer: CI bot
  • Author(s): Kyle Nitzsche
  • Date: 2014-04-04 14:11:26 UTC
  • mfrom: (153.1.5 ubuntu-html5-theme)
  • Revision ID: ps-jenkins@lists.canonical.com-20140404141126-k20bujy0hmwqsage
1) Fix lp bug https://bugs.launchpad.net/ubuntu-html5-theme/+bug/1241029

2) Improve doc building as follows:
  * add build script for docs: yuidoc-build.sh.(same as in unity-webapps-qml)
  * add docslib.py, used by yuidoc-build.sh to obtain bzr branch rev and
    insert it into yuidoc.json for use during build
  * add DOCSREADMET.txt: critical info about building docs
  * yuidoc.json: add majorversion field and set it to current framework: html-14.04-dev.
    The bzr branch rev is appended to this to create useful version field, which is consumed by yuidoc build and
    inserted into built html.

   As a result, the built index.html states the framework and the branch bzr rev as follows:
   "API Docs for: HTML-14.04-dev~bzr155" Fixes: 1287826

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
The docs build systems is yudocjs.
 
2
 
 
3
Info: http://yui.github.io/yuidoc/syntax/
 
4
 
 
5
Yuidocjs is installed via npm, globally:
 
6
 
 
7
# install npm
 
8
sudo apt-get install npm nodejs-legacy
 
9
 
 
10
# use npm to install yuidocjs globally
 
11
sudo npm -g install yuidocjs
 
12
 
 
13
# get ubuntu-html5-theme source branch
 
14
bzr branch lp:ubuntu-html5-theme
 
15
 
 
16
# move to the js dir
 
17
cd ubuntu-html5-theme/0.1/ambiance/js
 
18
 
 
19
# generate the docs from source
 
20
./yuidoc-build.sh
 
21
 
 
22
# docs are in new ./docsbuild/ dir
 
23