Permalink
Browse files

updated doc

  • Loading branch information...
1 parent 2f96297 commit efe211db5f857de198869d43fd600f956940d66a @sigma committed Feb 19, 2012
Showing with 132 additions and 7 deletions.
  1. +2 −0 _sources/index.txt
  2. +6 −0 _sources/intro.txt
  3. +19 −6 index.html
  4. +104 −0 intro.html
  5. +1 −1 searchindex.js
View
@@ -10,6 +10,7 @@ gh.el is a low-level client library to interact with the
`GitHub API <http://developer.github.com/>`.
Main features include:
+
* synchronous and asynchronous modes
* flexible authentication
* allows for multiple parallel sessions
@@ -19,6 +20,7 @@ Contents:
.. toctree::
:maxdepth: 2
+ intro
Indices and tables
View
@@ -0,0 +1,6 @@
+========
+ Basics
+========
+
+gh.el is built on top of Eieio. The scope of this client library is to provide
+plumbing primitives that will allow full use of the GitHub API.
View
@@ -25,7 +25,8 @@
<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="gh.el 0.3.2 documentation" href="#" />
+ <link rel="top" title="gh.el 0.3.2 documentation" href="#" />
+ <link rel="next" title="Basics" href="intro.html" />
</head>
<body>
<div class="related">
@@ -34,6 +35,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="intro.html" title="Basics"
+ accesskey="N">next</a> |</li>
<li><a href="#">gh.el 0.3.2 documentation</a> &raquo;</li>
</ul>
</div>
@@ -47,13 +51,16 @@
<h1>Welcome to gh.el&#8217;s documentation!<a class="headerlink" href="#welcome-to-gh-el-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>gh.el is a low-level client library to interact with the
<cite>GitHub API &lt;http://developer.github.com/&gt;</cite>.</p>
-<p>Main features include:
-* synchronous and asynchronous modes
-* flexible authentication
-* allows for multiple parallel sessions</p>
+<p>Main features include:</p>
+<ul class="simple">
+<li>synchronous and asynchronous modes</li>
+<li>flexible authentication</li>
+<li>allows for multiple parallel sessions</li>
+</ul>
<p>Contents:</p>
<div class="toctree-wrapper compound">
-<ul class="simple">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="intro.html">Basics</a></li>
</ul>
</div>
</div>
@@ -80,6 +87,9 @@
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="intro.html"
+ title="next chapter">Basics</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
@@ -108,6 +118,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
+ <li class="right" >
+ <a href="intro.html" title="Basics"
+ >next</a> |</li>
<li><a href="#">gh.el 0.3.2 documentation</a> &raquo;</li>
</ul>
</div>
View
@@ -0,0 +1,104 @@
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Basics &mdash; gh.el 0.3.2 documentation</title>
+
+ <link rel="stylesheet" href="_static/default.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.3.2',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <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="gh.el 0.3.2 documentation" href="index.html" />
+ <link rel="prev" title="Welcome to gh.el’s documentation!" href="index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="index.html" title="Welcome to gh.el’s documentation!"
+ accesskey="P">previous</a> |</li>
+ <li><a href="index.html">gh.el 0.3.2 documentation</a> &raquo;</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <div class="section" id="basics">
+<h1>Basics<a class="headerlink" href="#basics" title="Permalink to this headline">¶</a></h1>
+<p>gh.el is built on top of Eieio. The scope of this client library is to provide
+plumbing primitives that will allow full use of the GitHub API.</p>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="index.html"
+ title="previous chapter">Welcome to gh.el&#8217;s documentation!</a></p>
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/intro.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 class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="index.html" title="Welcome to gh.el’s documentation!"
+ >previous</a> |</li>
+ <li><a href="index.html">gh.el 0.3.2 documentation</a> &raquo;</li>
+ </ul>
+ </div>
+ <div class="footer">
+ &copy; Copyright 2011, Yann Hodique.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
+ </div>
+ </body>
+</html>
View

Some generated files are not rendered by default. Learn more.

Oops, something went wrong.

0 comments on commit efe211d

Please sign in to comment.