Adding en documentation

boxbilling · May 19, 2014 · 245c6b4 · 245c6b4
1 parent da14ceb
commit 245c6b4
Show file tree

Hide file tree

Showing 17 changed files with 1,149 additions and 0 deletions.
diff --git a/en/_static/adctheme.css b/en/_static/adctheme.css
diff --git a/en/_static/breadcrumb_background.png b/en/_static/breadcrumb_background.png
diff --git a/en/_static/configurationblock.css b/en/_static/configurationblock.css
@@ -0,0 +1,96 @@
+div.configuration-block ul.simple
+{
+    margin: 0;
+    padding: 0;
+}
+
+div.configuration-block ul.simple li
+{
+  margin: 0 !important;
+  margin-right: 5px !important;
+  display: inline;
+  margin-left: 10px;
+  padding: 10px;
+}
+
+div.configuration-block em
+{
+  margin-bottom: 10px;
+}
+
+div.configuration-block li
+{
+  padding: 5px;
+}
+
+div.configuration-block em
+{
+    font-style: normal;
+    font-size: 90%;
+}
+
+div.jsactive
+{
+  position: relative;
+}
+
+div.jsactive ul
+{
+  list-style: none;
+}
+
+div.jsactive li
+{
+  float: left;
+  list-style: none;
+  margin-left: 0;
+  -moz-border-radius: 5px; -webkit-border-radius: 5px; border-radius: 5px;
+  background-color: #ddd;
+  margin-right: 5px;
+}
+
+div.jsactive .selected
+{
+    background-color: #000;
+}
+
+div.jsactive .selected a
+{
+    color: #fff;
+    text-decoration: none;
+}
+
+div.jsactive .selected a:hover
+{
+    color: #fff;
+    text-decoration: underline;
+}
+
+div.jsactive a
+{
+    color: #000;
+    text-decoration: none;
+}
+
+div.jsactive a:hover
+{
+    color: #000;
+    text-decoration: underline;
+}
+
+div.jsactive div
+{
+  position: absolute;
+  top: 30px;
+  left: 0;
+}
+
+div.jsactive div div
+{
+  position: static;
+}
+
+div.jsactive pre
+{
+    margin: 0;
+}
diff --git a/en/_static/configurationblock.js b/en/_static/configurationblock.js
@@ -0,0 +1,34 @@
+$(document).ready(function(){
+  $('div.configuration-block [class^=highlight-]').hide();
+  $('div.configuration-block [class^=highlight-]').width($('div.configuration-block').width());
+
+  $('div.configuration-block').addClass('jsactive');
+  $('div.configuration-block').addClass('clearfix');
+
+  $('div.configuration-block').each(function (){
+      var el = $('[class^=highlight-]:first', $(this));
+      el.show();
+      el.parents('ul').height(el.height() + 40);
+  });
+
+  // Global
+  $('div.configuration-block li').each(function(){
+    var str = $(':first', $(this)).html();
+    $(':first ', $(this)).html('');
+    $(':first ', $(this)).append('<a href="#">' + str + '</a>')
+    $(':first', $(this)).bind('click', function(){
+      $('[class^=highlight-]', $(this).parents('ul')).hide();
+      $('li', $(this).parents('ul')).removeClass('selected');
+      $(this).parent().addClass('selected');
+
+      var block = $('[class^=highlight-]', $(this).parent('li'));
+      block.show();
+      block.parents('ul').height(block.height() + 40);
+      return false;
+    });
+  });
+
+  $('div.configuration-block').each(function (){
+      $('li:first', $(this)).addClass('selected');
+  });
+});
diff --git a/en/_static/documentation.png b/en/_static/documentation.png
diff --git a/en/_static/header_sm_mid.png b/en/_static/header_sm_mid.png
diff --git a/en/_static/logo.png b/en/_static/logo.png
diff --git a/en/_static/mobile.css b/en/_static/mobile.css
@@ -0,0 +1,17 @@
+/*
+ * CSS adjustments (overrides) for mobile browsers that cannot handle
+ * fix-positioned div's very well.
+ * This makes long pages scrollable on mobile browsers.
+ */
+
+#breadcrumbs {
+	display: none !important;
+}
+
+.document {
+    bottom: inherit !important;
+}
+
+#sphinxsidebar {
+    bottom: inherit !important;
+}
diff --git a/en/_static/searchfield_leftcap.png b/en/_static/searchfield_leftcap.png
diff --git a/en/_static/searchfield_repeat.png b/en/_static/searchfield_repeat.png
diff --git a/en/_static/searchfield_rightcap.png b/en/_static/searchfield_rightcap.png
diff --git a/en/_static/title_background.png b/en/_static/title_background.png
diff --git a/en/_static/toc.js b/en/_static/toc.js
@@ -0,0 +1,20 @@
+var TOC = {
+    load: function () {
+        $('#toc_button').click(TOC.toggle);
+    },
+
+    toggle: function () {
+        if ($('#sphinxsidebar').toggle().is(':hidden')) {
+            $('div.document').css('left', "0px");
+            $('toc_button').removeClass("open");
+        } else {
+            $('div.document').css('left', "230px");
+            $('#toc_button').addClass("open");
+        }
+        return $('#sphinxsidebar');
+    }
+};
+
+$(document).ready(function () {
+    TOC.load();
+});
diff --git a/en/_static/triangle_closed.png b/en/_static/triangle_closed.png
diff --git a/en/_static/triangle_left.png b/en/_static/triangle_left.png
diff --git a/en/_static/triangle_open.png b/en/_static/triangle_open.png
diff --git a/en/_templates/layout.html b/en/_templates/layout.html
@@ -0,0 +1,193 @@
+{% extends "basic/layout.html" %}
+{%- 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 %}
+{%- 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 }}" href="{{ parents[-1].link|e }}" />
+    {%- endif %}
+    {%- if next %}
+    <link rel="next" title="{{ next.title|striptags }}" href="{{ next.link|e }}" />
+    {%- endif %}
+    {%- if prev %}
+    <link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}" />
+    {%- endif %}
+    <link media="only screen and (max-device-width: 480px)" href="{{ pathto('_static/mobile.css', 1) }}" type="text/css" rel="stylesheet" />
+    <link rel="stylesheet" href="{{ pathto('_static/configurationblock.css', 1) }}" type="text/css" />
+    <script type="text/javascript" src="{{ pathto('_static/configurationblock.js', 1) }}"></script>
+{%- endblock %}
+{%- block extrahead %} {% endblock %}
+{%- block header %}{% endblock %}
+{%- block relbar1 %}
+<div id="docstitle">
+	<p>{{docstitle}}</p>
+    <ul id="site-menu">
+        <li><a href="http://www.boxbilling.com/" target="_blank">Home</a></li>
+        <li><a href="http://www.boxbilling.com/demo" target="_blank">Live demo</a></li>
+        <li><a href="http://www.boxbilling.com/order" target="_blank">Order</a></li>
+        <li><a href="http://www.boxbilling.com/download" target="_blank">Download</a></li>
+        <li><a href="http://www.boxbilling.com/forum" target="_blank">Forum</a></li>
+    </ul>
+</div>
+<div id="header">
+	<div id="title"><h1>{{ title|striptags }}</h1></div>
+	<ul id="headerButtons">
+		<li id="toc_button"><div class="headerButton"><a href="#">Table of Contents</a></div></li>
+		<li id="page_buttons">
+			{%- for rellink in rellinks %}
+			<div class="headerButton"><a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags }}" {{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a></div>
+			{%- endfor %}
+		</li>
+	</ul>
+</div>
+{% endblock %}
+
+{%- block sidebar1 %}
+{%- if not embedded %}{% if not theme_nosidebar|tobool %}
+<div id="sphinxsidebar">
+  <div class="sphinxsidebarwrapper">
+    {%- block sidebartoc %}
+	<ul><li class="toctree-l1"><a href="{{ pathto(master_doc) }}">{{ _('Main Page') }}</a></li></ul>
+	{{ toctree() }}
+    {%- endblock %}
+    {%- block sidebarrel %}
+    {%- endblock %}
+    {%- block sidebarsourcelink %}
+    {%- if show_source and has_source and sourcename %}
+      <h3>{{ _('This Page') }}</h3>
+      <ul class="this-page-menu">
+        <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
+               rel="nofollow">{{ _('Show Source') }}</a></li>
+      </ul>
+    {%- endif %}
+    {%- endblock %}
+    {%- if customsidebar %}
+    {% include customsidebar %}
+    {%- endif %}
+    {%- block sidebarsearch %}
+    {%- if pagename != "search" %}
+    <div id="searchbox" style="display: none">
+      {# <h3>{{ _('Quick search') }}</h3> #}
+        <form class="search" action="{{ pathto('search') }}" method="get">
+			<div class="search-wrapper">
+			<span class="search-left"></span>
+			<input class="prettysearch" type="text" name="q" size="18" />
+			<span class="search-right">&nbsp;</span>
+			</div>
+          <input type="submit" value="{{ _('Search') }}" class="searchbutton" />
+          <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>
+    {%- endif %}
+    {%- endblock %}
+    {%- block sidebarlogo %}
+    {%- if logo %}
+      <p class="logo"><a href="http://www.boxbilling.com/">
+        <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
+      </a></p>
+    {%- endif %}
+    {%- endblock %}
+  </div>
+</div>
+{%- endif %}{% endif %}
+
+{% endblock %}
+{%- block document %}
+      <div class="documentwrapper">
+      {%- if not embedded %}{% if not theme_nosidebar|tobool %}
+        <div class="bodywrapper">
+      {%- endif %}{% endif %}
+          <div class="body">
+            {% block body %} {% endblock %}
+          </div>
+      {%- if not embedded %}{% if not theme_nosidebar|tobool %} 
+        </div>
+      {%- endif %}{% endif %}
+      </div>
+
+    <div class="comments">
+        <h2>Contribute to this page</h2>
+        <p>User contributed notes. Please use the comment section to provide tips, notes and examples. To ask for support, request feature or to provide feedback use the <a href="http://www.boxbilling.com/" target="_blank">forum</a>. For bug reports use <a href="https://github.com/boxbilling/BoxBilling/issues" target="_blank" rel="nofollow">Github Issue Tracker</a>.</p>
+        <!-- Discuss Comments -->  
+        <div id="disqus_thread"></div>
+        <script type="text/javascript">
+            /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
+            var disqus_shortname = 'boxbilling'; // required: replace example with your forum shortname
+
+            /* * * DON'T EDIT BELOW THIS LINE * * */
+            (function() {
+                var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+                dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
+                (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+            })();
+        </script>
+
+        <!-- Facebook Comments -->  
+        <!--   
+            <script src="http://connect.facebook.net/en_US/all.js#xfbml=1"></script>
+            <fb:comments href="www.boxbilling.com" num_posts="20" width="940"></fb:comments>
+        -->    
+    </div>
+
+    <div class="footer">
+    <p>{%- 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 %}
+    {%- if last_updated %}
+      {% trans last_updated=last_updated|e %} (Last updated: {{ last_updated }}){% endtrans %}
+    {%- endif %}
+    {%- if show_sphinx %}
+      {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
+    {%- endif %}
+	</p>
+    </div>
+{%- endblock %}
+{%- block sidebar2 %}{% endblock %}
+{%- block relbar2 %}{% endblock %}
+{%- block footer %}
+	<div id="breadcrumbs">
+		{%- for parent in parents %}
+		<a href="{{ parent.link|e }}" {{ accesskey("U") }}>{{ parent.title|safe }}</a><img src="{{ pathto('_static/triangle_closed.png', 1) }}" height="9" width="9" alt="&gt;" />
+		{%- endfor %}
+		{{ title|safe|e }}
+	</div>
+	<script type="text/javascript" charset="utf-8" src="{{ pathto('_static/toc.js', 1) }}"></script>
+
+    <!-- GA -->
+    <script type="text/javascript">
+
+      var _gaq = _gaq || [];
+      _gaq.push(['_setAccount', 'UA-1553989-16']);
+      _gaq.push(['_trackPageview']);
+
+      (function() {
+        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+      })();
+
+    </script>
+{%- endblock %}