Skip to content

Commit

Permalink
Updated docs with info on almond build.
Browse files Browse the repository at this point in the history
  • Loading branch information
jcbrand committed Aug 25, 2013
1 parent 0fefc55 commit 464d42c
Show file tree
Hide file tree
Showing 9 changed files with 111 additions and 86 deletions.
Binary file modified docs/doctrees/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: cc4e774ae6c30c8f75f9540598d47e5a
config: 4e01f0b4332cc0ad20271406d2d00beb
tags: fbb0d17656682115ca4d033fb2f83ba1
8 changes: 8 additions & 0 deletions docs/html/_sources/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,14 @@ To minify the Javascript and CSS, run the following command:

grunt minify

.. Note ::
Since release 0.6.0, I'm using `almond <https://github.com/jrburke/almond>`_
instead of `require.js <http://requirejs.org>`_. The
`grunt-contrib-requirejs <https://github.com/gruntjs/grunt-contrib-requirejs>`_
plugin however doesn't support *almond*. I therefore now build it manually
(the old way again), like this: ``r.js -o build.js``. CSS can be minimized
separately via ``grunt cssmin``.

Javascript will be bundled and minified via `require.js`_'s optimization tool.
You can `read more about require.js's optimizer here`_.

Expand Down
10 changes: 5 additions & 5 deletions docs/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Index &mdash; Converse.js 0.5.3 documentation</title>
<title>Index &mdash; Converse.js 0.6.0 documentation</title>

<link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.5.3',
VERSION: '0.6.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -26,7 +26,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Converse.js 0.5.3 documentation" href="index.html" />
<link rel="top" title="Converse.js 0.6.0 documentation" href="index.html" />
</head>
<body>
<div id="header_wrap" class="outer">
Expand All @@ -51,7 +51,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">Converse.js 0.5.3 documentation</a> &raquo;</li>
<li><a href="index.html">Converse.js 0.6.0 documentation</a> &raquo;</li>
</ul>
</div>
<section id="main_content" class="inner">
Expand Down Expand Up @@ -80,7 +80,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li><a href="index.html">Converse.js 0.5.3 documentation</a> &raquo;</li>
<li><a href="index.html">Converse.js 0.6.0 documentation</a> &raquo;</li>
</ul>
</div>
</div>
Expand Down
155 changes: 82 additions & 73 deletions docs/html/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/html/objects.inv
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sphinx inventory version 2
# Project: Converse.js
# Version: 0.5.3
# Version: 0.6.0
# The remainder of this file is compressed using zlib.
x�m��
� �{�"���]�;
Expand Down
10 changes: 5 additions & 5 deletions docs/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Search &mdash; Converse.js 0.5.3 documentation</title>
<title>Search &mdash; Converse.js 0.6.0 documentation</title>

<link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.5.3',
VERSION: '0.6.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -25,7 +25,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="Converse.js 0.5.3 documentation" href="index.html" />
<link rel="top" title="Converse.js 0.6.0 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
Expand Down Expand Up @@ -55,7 +55,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">Converse.js 0.5.3 documentation</a> &raquo;</li>
<li><a href="index.html">Converse.js 0.6.0 documentation</a> &raquo;</li>
</ul>
</div>
<section id="main_content" class="inner">
Expand Down Expand Up @@ -100,7 +100,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="index.html">Converse.js 0.5.3 documentation</a> &raquo;</li>
<li><a href="index.html">Converse.js 0.6.0 documentation</a> &raquo;</li>
</ul>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,14 @@ To minify the Javascript and CSS, run the following command:

grunt minify

.. Note ::
Since release 0.6.0, I'm using `almond <https://github.com/jrburke/almond>`_
instead of `require.js <http://requirejs.org>`_. The
`grunt-contrib-requirejs <https://github.com/gruntjs/grunt-contrib-requirejs>`_
plugin however doesn't support *almond*. I therefore now build it manually
(the old way again), like this: ``r.js -o build.js``. CSS can be minimized
separately via ``grunt cssmin``.
Javascript will be bundled and minified via `require.js`_'s optimization tool.
You can `read more about require.js's optimizer here`_.

Expand Down

0 comments on commit 464d42c

Please sign in to comment.