Permalink
Browse files

restructure documentation

  • Loading branch information...
sigma committed Dec 4, 2011
1 parent c2ad78a commit ea51da075865f41db385fb38276cc88fdd43b995
Showing with 19 additions and 47 deletions.
  1. +0 −44 doc/gh.texi
  2. +3 −3 docs/source/conf.py
  3. +10 −0 docs/source/index.rst
  4. +6 −0 docs/source/intro.rst
View

This file was deleted.

Oops, something went wrong.
View
@@ -183,7 +183,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'ghel.tex', u'gh.el Documentation',
('index', 'ghel.tex', u'gh.el User Manual',
u'Yann Hodique', 'manual'),
]
@@ -213,7 +213,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'ghel', u'gh.el Documentation',
('index', 'ghel', u'gh.el User Manual',
[u'Yann Hodique'], 1)
]
@@ -227,7 +227,7 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'gh', u'gh.el Documentation',
('index', 'gh', u'gh.el User Manual',
u'Yann Hodique', 'gh.el', 'Using GitHub from Emacs.',
'Emacs'),
]
View
@@ -6,11 +6,21 @@
Welcome to gh.el's documentation!
=================================
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
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.

0 comments on commit ea51da0

Please sign in to comment.