Chapril/xmpp.chapril.org-conversejs
Chapril/xmpp.chapril.org-conversejs
25
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Add a custom sphinx theme

Browse Source 
Makes the docs look similar to the main site
This commit is contained in:
JC Brand 2013-04-26 21:49:26 +02:00
parent 2442e1ea71
commit 63508ae4cd
12 changed files with 377 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/html/.buildinfo
View File

@ -1,4 +1,4 @@
# Sphinx build info version 1 # 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. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0dbb8eaf5b34cb5e882194dcc7b2c3c8 config: 11cf73c9901b429394dccc272608c52e
tags: fbb0d17656682115ca4d033fb2f83ba1 tags: fbb0d17656682115ca4d033fb2f83ba1

8
docs/html/_sources/index.txt
View File

@ -3,10 +3,6 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
=========================
Converse.js documentation
=========================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -15,9 +11,9 @@ Converse.js documentation
:local: :local:
------------------------ ========================
Configuration variables: Configuration variables:
------------------------ ========================
Prebind Prebind
======== ========

31
docs/html/_static/stylesheet.css Normal file
View File

@ -0,0 +1,31 @@
/*******************************************************************************
Slate Theme for GitHub Pages
by Jason Costello, @jsncostello
*******************************************************************************/
@import url("default.css");
@import url("../../../stylesheets/stylesheet.css");
@import url(pygment_trac.css);
div.body,
div.document {
background-color: transparent;
}
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
background-color: transparent;
border-bottom: 0;
}
h1#project_title a {
color: white;
}
h1 a {
color: #0069ba;
}

53
docs/html/genindex.html
View File

@ -1,7 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@ -12,7 +11,7 @@
<title>Index &mdash; Converse.js 0.3 documentation</title> <title>Index &mdash; Converse.js 0.3 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
@ -30,6 +29,22 @@
<link rel="top" title="Converse.js 0.3 documentation" href="index.html" /> <link rel="top" title="Converse.js 0.3 documentation" href="index.html" />
</head> </head>
<body> <body>
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/jcbrand/converse.js">View on GitHub</a>
<h1 id="project_title"><a href="http://conversejs.org">Converse.js</a></h1>
<h2 id="project_tagline">Documentation</h2>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/jcbrand/converse.js/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/jcbrand/converse.js/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
<div id="main_content_wrap" class="outer">
<div class="related"> <div class="related">
<h3>Navigation</h3> <h3>Navigation</h3>
<ul> <ul>
@ -38,11 +53,11 @@
accesskey="I">index</a></li> accesskey="I">index</a></li>
<li><a href="index.html">Converse.js 0.3 documentation</a> &raquo;</li> <li><a href="index.html">Converse.js 0.3 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
<section id="main_content" class="inner">
<div class="document"> <div class="document">
<div class="documentwrapper"> <div class="documentwrapper">
<div class="bodywrapper">
<div class="body"> <div class="body">
@ -54,30 +69,11 @@
</div> </div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div> </div>
<div class="clearer"></div> <div class="clearer"></div>
</div> </div>
</section>
<div class="related"> <div class="related">
<h3>Navigation</h3> <h3>Navigation</h3>
<ul> <ul>
@ -87,9 +83,12 @@
<li><a href="index.html">Converse.js 0.3 documentation</a> &raquo;</li> <li><a href="index.html">Converse.js 0.3 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
<div class="footer"> </div>
<div id="footer_wrap" class="outer">
<footer class="inner">
&copy; Copyright 2013, JC Brand. &copy; Copyright 2013, JC Brand.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. <p class="copyright">Converse.js created by <a href="http://opkode.com" target="_blank">jcbrand</a></p>
</footer>
</div> </div>
</body> </body>
</html> </html>

92
docs/html/index.html
View File

@ -1,5 +1,4 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@ -8,9 +7,9 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Converse.js documentation &mdash; Converse.js 0.3 documentation</title> <title>Configuration variables: &mdash; Converse.js 0.3 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
@ -28,6 +27,22 @@
<link rel="top" title="Converse.js 0.3 documentation" href="#" /> <link rel="top" title="Converse.js 0.3 documentation" href="#" />
</head> </head>
<body> <body>
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/jcbrand/converse.js">View on GitHub</a>
<h1 id="project_title"><a href="http://conversejs.org">Converse.js</a></h1>
<h2 id="project_tagline">Documentation</h2>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/jcbrand/converse.js/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/jcbrand/converse.js/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
<div id="main_content_wrap" class="outer">
<div class="related"> <div class="related">
<h3>Navigation</h3> <h3>Navigation</h3>
<ul> <ul>
@ -36,16 +51,14 @@
accesskey="I">index</a></li> accesskey="I">index</a></li>
<li><a href="#">Converse.js 0.3 documentation</a> &raquo;</li> <li><a href="#">Converse.js 0.3 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
<section id="main_content" class="inner">
<div class="document"> <div class="document">
<div class="documentwrapper"> <div class="documentwrapper">
<div class="bodywrapper">
<div class="body"> <div class="body">
<div class="section" id="converse-js-documentation"> <div class="toctree-wrapper compound">
<h1>Converse.js documentation<a class="headerlink" href="#converse-js-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul class="simple"> <ul class="simple">
</ul> </ul>
</div> </div>
@ -64,9 +77,9 @@
</ul> </ul>
</div> </div>
<div class="section" id="configuration-variables"> <div class="section" id="configuration-variables">
<h2><a class="toc-backref" href="#id1">Configuration variables:</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline"></a></h2> <h1><a class="toc-backref" href="#id1">Configuration variables:</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline"></a></h1>
<div class="section" id="prebind"> <div class="section" id="prebind">
<h3><a class="toc-backref" href="#id2">Prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline"></a></h3> <h2><a class="toc-backref" href="#id2">Prebind</a><a class="headerlink" href="#prebind" title="Permalink to this headline"></a></h2>
<p>Use this option when you want to attach to an existing XMPP connection that was <p>Use this option when you want to attach to an existing XMPP connection that was
already authenticated (usually on the backend before page load).</p> already authenticated (usually on the backend before page load).</p>
<p>This is useful when you don&#8217;t want to render the login form on the chat control <p>This is useful when you don&#8217;t want to render the login form on the chat control
@ -86,18 +99,18 @@ have to write a Javascript snippet to attach to the set up connection:</p>
RID (Request ID), which you use when you attach to the connection.</p> RID (Request ID), which you use when you attach to the connection.</p>
</div> </div>
<div class="section" id="fullname"> <div class="section" id="fullname">
<h3><a class="toc-backref" href="#id3">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline"></a></h3> <h2><a class="toc-backref" href="#id3">fullname</a><a class="headerlink" href="#fullname" title="Permalink to this headline"></a></h2>
<p>If you are using prebinding, you need to specify the fullname of the currently <p>If you are using prebinding, you need to specify the fullname of the currently
logged in user.</p> logged in user.</p>
</div> </div>
<div class="section" id="bosh-service-url"> <div class="section" id="bosh-service-url">
<h3><a class="toc-backref" href="#id4">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline"></a></h3> <h2><a class="toc-backref" href="#id4">bosh_service_url</a><a class="headerlink" href="#bosh-service-url" title="Permalink to this headline"></a></h2>
<p>Connections to an XMPP server depend on a BOSH connection manager which acts as <p>Connections to an XMPP server depend on a BOSH connection manager which acts as
a middle man between HTTP and XMPP.</p> a middle man between HTTP and XMPP.</p>
<p>See <a class="reference external" href="http://metajack.im/2008/09/08/which-bosh-server-do-you-need/l">here</a> for more information.</p> <p>See <a class="reference external" href="http://metajack.im/2008/09/08/which-bosh-server-do-you-need/l">here</a> for more information.</p>
</div> </div>
<div class="section" id="xhr-user-search"> <div class="section" id="xhr-user-search">
<h3><a class="toc-backref" href="#id5">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline"></a></h3> <h2><a class="toc-backref" href="#id5">xhr_user_search</a><a class="headerlink" href="#xhr-user-search" title="Permalink to this headline"></a></h2>
<p>There are two ways to add users.</p> <p>There are two ways to add users.</p>
<ul class="simple"> <ul class="simple">
<li>The user inputs a valid JID (Jabber ID), and the user is added as a pending</li> <li>The user inputs a valid JID (Jabber ID), and the user is added as a pending</li>
@ -108,60 +121,22 @@ a middle man between HTTP and XMPP.</p>
be used.</p> be used.</p>
</div> </div>
<div class="section" id="auto-subscribe"> <div class="section" id="auto-subscribe">
<h3><a class="toc-backref" href="#id6">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline"></a></h3> <h2><a class="toc-backref" href="#id6">auto_subscribe</a><a class="headerlink" href="#auto-subscribe" title="Permalink to this headline"></a></h2>
<p>If true, the user will automatically subscribe back to any contact requests.</p> <p>If true, the user will automatically subscribe back to any contact requests.</p>
</div> </div>
<div class="section" id="animate"> <div class="section" id="animate">
<h3><a class="toc-backref" href="#id7">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline"></a></h3> <h2><a class="toc-backref" href="#id7">animate</a><a class="headerlink" href="#animate" title="Permalink to this headline"></a></h2>
<p>Show animations, for example when opening and closing chat boxes.</p> <p>Show animations, for example when opening and closing chat boxes.</p>
</div> </div>
</div>
</div> </div>
</div> </div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Converse.js documentation</a><ul>
<li><a class="reference internal" href="#configuration-variables">Configuration variables:</a><ul>
<li><a class="reference internal" href="#prebind">Prebind</a></li>
<li><a class="reference internal" href="#fullname">fullname</a></li>
<li><a class="reference internal" href="#bosh-service-url">bosh_service_url</a></li>
<li><a class="reference internal" href="#xhr-user-search">xhr_user_search</a></li>
<li><a class="reference internal" href="#auto-subscribe">auto_subscribe</a></li>
<li><a class="reference internal" href="#animate">animate</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div> </div>
<div class="clearer"></div> <div class="clearer"></div>
</div> </div>
</section>
<div class="related"> <div class="related">
<h3>Navigation</h3> <h3>Navigation</h3>
<ul> <ul>
@ -171,9 +146,12 @@ be used.</p>
<li><a href="#">Converse.js 0.3 documentation</a> &raquo;</li> <li><a href="#">Converse.js 0.3 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
<div class="footer"> </div>
<div id="footer_wrap" class="outer">
<footer class="inner">
&copy; Copyright 2013, JC Brand. &copy; Copyright 2013, JC Brand.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. <p class="copyright">Converse.js created by <a href="http://opkode.com" target="_blank">jcbrand</a></p>
</footer>
</div> </div>
</body> </body>
</html> </html>

37
docs/html/search.html
View File

@ -1,5 +1,4 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@ -10,7 +9,7 @@
<title>Search &mdash; Converse.js 0.3 documentation</title> <title>Search &mdash; Converse.js 0.3 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/stylesheet.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
@ -34,6 +33,22 @@
</head> </head>
<body> <body>
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/jcbrand/converse.js">View on GitHub</a>
<h1 id="project_title"><a href="http://conversejs.org">Converse.js</a></h1>
<h2 id="project_tagline">Documentation</h2>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/jcbrand/converse.js/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/jcbrand/converse.js/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
<div id="main_content_wrap" class="outer">
<div class="related"> <div class="related">
<h3>Navigation</h3> <h3>Navigation</h3>
<ul> <ul>
@ -42,11 +57,11 @@
accesskey="I">index</a></li> accesskey="I">index</a></li>
<li><a href="index.html">Converse.js 0.3 documentation</a> &raquo;</li> <li><a href="index.html">Converse.js 0.3 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
<section id="main_content" class="inner">
<div class="document"> <div class="document">
<div class="documentwrapper"> <div class="documentwrapper">
<div class="bodywrapper">
<div class="body"> <div class="body">
<h1 id="search-documentation">Search</h1> <h1 id="search-documentation">Search</h1>
@ -74,14 +89,11 @@
</div> </div>
</div> </div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
</div>
</div> </div>
<div class="clearer"></div> <div class="clearer"></div>
</div> </div>
</section>
<div class="related"> <div class="related">
<h3>Navigation</h3> <h3>Navigation</h3>
<ul> <ul>
@ -91,9 +103,12 @@
<li><a href="index.html">Converse.js 0.3 documentation</a> &raquo;</li> <li><a href="index.html">Converse.js 0.3 documentation</a> &raquo;</li>
</ul> </ul>
</div> </div>
<div class="footer"> </div>
<div id="footer_wrap" class="outer">
<footer class="inner">
&copy; Copyright 2013, JC Brand. &copy; Copyright 2013, JC Brand.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. <p class="copyright">Converse.js created by <a href="http://opkode.com" target="_blank">jcbrand</a></p>
</footer>
</div> </div>
</body> </body>
</html> </html>

2
docs/html/searchindex.js
View File

@ -1 +1 @@
Search.setIndex({objects:{},terms:{firstnam:0,show:0,xmpp:0,session:0,current:0,jid:0,middl:0,depend:0,configur:0,add:0,pend:0,text:0,input:0,match:0,anim:0,"return":0,mechan:0,requir:0,enabl:0,success:0,list:0,authent:0,server:0,have:0,each:0,manag:0,set:0,some:0,back:0,stroph:0,see:0,connect:0,pass:0,close:0,fullnam:0,variabl:0,index:[],open:0,content:0,between:0,"new":0,method:0,javascript:0,here:0,bosh:0,box:0,search:[],convers:0,mysit:0,page:0,act:0,login:0,com:0,first:0,load:0,render:0,modul:[],lastnam:0,automat:0,alreadi:0,jabber:0,backend:0,log:0,wai:0,xhr_user_search:0,two:0,attach:0,json:0,call:0,subscrib:0,besid:0,more:0,"function":0,option:0,form:0,specifi:0,part:0,"true":0,must:0,made:0,"default":0,second:0,exampl:0,xhr:0,can:0,otherwis:0,control:0,want:0,onconnect:0,auto_subscrib:0,ani:0,indic:[],exist:0,chat:0,tabl:0,need:0,rid:0,bosh_service_url:0,prebind:0,write:0,end:0,welcom:[],make:0,when:0,snippet:0,also:0,valid:0,which:0,sid:0,you:0,document:0,sure:0,http:0,object:0,befor:0,user:0,data:0,man:0,don:0,url:0,request:0,inform:0,contact:0,thi:0,choos:0,usual:0},objtypes:{},titles:["Converse.js documentation"],objnames:{},filenames:["index"]}) Search.setIndex({objects:{},terms:{firstnam:0,show:0,xmpp:0,session:0,current:0,jid:0,middl:0,depend:0,configur:0,add:0,pend:0,text:0,input:0,match:0,anim:0,"return":0,mechan:0,chat:0,requir:0,enabl:0,success:0,list:0,authent:0,server:0,each:0,page:0,set:0,some:0,back:0,stroph:0,see:0,connect:0,pass:0,close:0,fullnam:0,variabl:0,jabber:0,content:0,between:0,"new":0,method:0,javascript:0,here:0,bosh:0,valid:0,box:0,convers:0,mysit:0,manag:0,act:0,login:0,com:0,first:0,load:0,render:0,lastnam:0,automat:0,alreadi:0,open:0,backend:0,log:0,wai:0,data:0,two:0,attach:0,json:0,call:0,subscrib:0,besid:0,more:0,"function":0,option:0,form:0,specifi:0,part:0,"true":0,must:0,made:0,"default":0,second:0,xhr:0,can:0,otherwis:0,control:0,have:0,onconnect:0,auto_subscrib:0,ani:0,exist:0,want:0,tabl:0,need:0,rid:0,bosh_service_url:0,prebind:0,write:0,end:0,make:0,when:0,snippet:0,also:0,contact:0,which:0,sid:0,you:0,sure:0,http:0,object:0,befor:0,user:0,xhr_user_search:0,man:0,don:0,url:0,request:0,inform:0,exampl:0,thi:0,choos:0,usual:0},objtypes:{},titles:["Configuration variables:"],objnames:{},filenames:["index"]})

212
docs/source/_templates/layout.html Normal file
View File

@ -0,0 +1,212 @@
{%- block doctype -%}
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
{%- endblock %}
{%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
(sidebars != []) %}
{%- set url_root = pathto('', 1) %}
{# XXX necessary? #}
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
{%- if not embedded and docstitle %}
{%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
{%- else %}
{%- set titlesuffix = "" %}
{%- endif %}
{%- macro relbar() %}
<div class="related">
<h3>{{ _('Navigation') }}</h3>
<ul>
{%- for rellink in rellinks %}
<li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
{%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
{%- endfor %}
{%- block rootrellink %}
<li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
{%- endblock %}
{%- for parent in parents %}
<li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
{%- endfor %}
{%- block relbaritems %} {% endblock %}
</ul>
</div>
{%- endmacro %}
{%- macro sidebar() %}
{%- if render_sidebar %}
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
{%- block sidebarlogo %}
{%- if logo %}
<p class="logo"><a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
</a></p>
{%- endif %}
{%- endblock %}
{%- if sidebars != None %}
{#- new style sidebar: explicitly include/exclude templates #}
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
{%- else %}
{#- old style sidebars: using blocks -- should be deprecated #}
{%- block sidebartoc %}
{%- include "localtoc.html" %}
{%- endblock %}
{%- block sidebarrel %}
{%- include "relations.html" %}
{%- endblock %}
{%- block sidebarsourcelink %}
{%- include "sourcelink.html" %}
{%- endblock %}
{%- if customsidebar %}
{%- include customsidebar %}
{%- endif %}
{%- block sidebarsearch %}
{%- include "searchbox.html" %}
{%- endblock %}
{%- endif %}
</div>
</div>
{%- endif %}
{%- endmacro %}
{%- macro script() %}
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '{{ url_root }}',
VERSION: '{{ release|e }}',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }}
};
</script>
{%- for scriptfile in script_files %}
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{%- endmacro %}
{%- macro css() %}
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
{%- for cssfile in css_files %}
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{%- endfor %}
{%- endmacro %}
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" />
{{ metatags }}
{%- block htmltitle %}
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
{%- endblock %}
{{ css() }}
{%- if not embedded %}
{{ script() }}
{%- if use_opensearch %}
<link rel="search" type="application/opensearchdescription+xml"
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
{%- endif %}
{%- if favicon %}
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
{%- endif %}
{%- endif %}
{%- block linktags %}
{%- if hasdoc('about') %}
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
{%- endif %}
{%- if hasdoc('genindex') %}
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
{%- endif %}
{%- if hasdoc('search') %}
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
{%- endif %}
{%- if hasdoc('copyright') %}
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
{%- endif %}
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
{%- if parents %}
<link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
{%- endif %}
{%- if next %}
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
{%- endif %}
{%- if prev %}
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
{%- endif %}
{%- endblock %}
{%- block extrahead %} {% endblock %}
</head>
<body>
{%- block header %}
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/jcbrand/converse.js">View on GitHub</a>
<h1 id="project_title"><a href="http://conversejs.org">Converse.js</a></h1>
<h2 id="project_tagline">Documentation</h2>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/jcbrand/converse.js/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/jcbrand/converse.js/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
{% endblock %}
<div id="main_content_wrap" class="outer">
{%- block relbar1 %}{{ relbar() }}{% endblock %}
<section id="main_content" class="inner">
{%- block content %}
{%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
<div class="document">
{%- block document %}
<div class="documentwrapper">
{%- if render_sidebar %}
<div class="bodywrapper">
{%- endif %}
<div class="body">
{% block body %} {% endblock %}
</div>
{%- if render_sidebar %}
</div>
{%- endif %}
</div>
{%- endblock %}
{%- block sidebar2 %}{{ sidebar() }}{% endblock %}
<div class="clearer"></div>
</div>
{%- endblock %}
</section>
{%- block relbar2 %}{{ relbar() }}{% endblock %}
</div>
{%- block footer %}
<div id="footer_wrap" class="outer">
<footer class="inner">
{%- if show_copyright %}
{%- if hasdoc('copyright') %}
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
{%- else %}
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
{%- endif %}
{%- endif %}
{%- if last_updated %}
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
{%- endif %}
<p class="copyright">Converse.js created by <a href="http://opkode.com" target="_blank">jcbrand</a></p>
</footer>
</div>
{%- endblock %}
</body>
</html>

10
docs/source/conf.py
View File

@ -91,15 +91,17 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'default' html_theme = 'theme'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
# documentation. # documentation.
#html_theme_options = {} html_theme_options = {
'nosidebar': True
}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = [] html_theme_path = ['.']
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
@ -228,7 +230,7 @@ man_pages = [
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'Conversejs', u'Converse.js Documentation', ('index', 'Conversejs', u'Converse.js Documentation',
u'JC Brand', 'Conversejs', 'One line description of project.', u'JC Brand', 'Conversejs', 'Open Source XMPP webchat',
'Miscellaneous'), 'Miscellaneous'),
] ]

8
docs/source/index.rst
View File

@ -3,10 +3,6 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
=========================
Converse.js documentation
=========================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -15,9 +11,9 @@ Converse.js documentation
:local: :local:
------------------------ ========================
Configuration variables: Configuration variables:
------------------------ ========================
Prebind Prebind
======== ========

31
docs/source/theme/static/stylesheet.css_t Normal file
View File

@ -0,0 +1,31 @@
/*******************************************************************************
Slate Theme for GitHub Pages
by Jason Costello, @jsncostello
*******************************************************************************/
@import url("default.css");
@import url("../../../stylesheets/stylesheet.css");
@import url(pygment_trac.css);
div.body,
div.document {
background-color: transparent;
}
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
background-color: transparent;
border-bottom: 0;
}
h1#project_title a {
color: white;
}
h1 a {
color: #0069ba;
}

4
docs/source/theme/theme.conf Normal file
View File

@ -0,0 +1,4 @@
[theme]
inherit = default
stylesheet = stylesheet.css
pygments_style = sphinx