Skip to content
Browse files

restructure documentation

  • Loading branch information...
1 parent c2ad78a commit ea51da075865f41db385fb38276cc88fdd43b995 @sigma committed Dec 4, 2011
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
44 doc/gh.texi
@@ -1,44 +0,0 @@
-\input texinfo.tex
-@setfilename gh.info
-@settitle gh.el User Manual
-@documentencoding utf-8
-
-@dircategory Emacs
-@direntry
-* gh.el: (gh). Using GitHub from Emacs.
-@end direntry
-
-@copying
-Copyright @copyright{} 2011 Yann Hodique.
-
-@quotation
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2 or
-any later version published by the Free Software Foundation; with no
-Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
-Texts.
-@end quotation
-@end copying
-
-@node Top
-@top gh.el User Manual
-
-gh.el is a low-level client library to interact with
-@uref{http://developer.github.com/,GitHub API}. Main features include:
-
-@itemize @bullet
-@item synchronous and asynchronous modes
-@item flexible authentication
-@item allows for multiple parallel sessions
-@end itemize
-
-@menu
-* Basics::
-@end menu
-
-@node Basics
-@chapter Basics
-
-gh.el is built on top of @xref{Top, Eieio, , eieio, Eieio}. The scope
-of this client library is to provide plumbing primitives that will
-allow full use of the GitHub API.
View
6 docs/source/conf.py
@@ -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
10 docs/source/index.rst
@@ -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
6 docs/source/intro.rst
@@ -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.
Something went wrong with that request. Please try again.