aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRafael G. Martins <rafael@rafaelmartins.eng.br>2010-06-04 19:42:00 -0300
committerRafael G. Martins <rafael@rafaelmartins.eng.br>2010-06-04 19:42:00 -0300
commit33434e8e36c187ab9021fb8e8dc13146a3f52b29 (patch)
tree5e2d77465d6c9ffdacce82a233c10d83c08cd658 /docs/index.rst
parentFixed .hgignore to ignore the builded docs (diff)
downloadg-octave-33434e8e36c187ab9021fb8e8dc13146a3f52b29.tar.gz
g-octave-33434e8e36c187ab9021fb8e8dc13146a3f52b29.tar.bz2
g-octave-33434e8e36c187ab9021fb8e8dc13146a3f52b29.zip
added some sphinx documentation
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst33
1 files changed, 25 insertions, 8 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 5c3041b..da0fd47 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,15 +6,32 @@
Welcome to g-Octave's documentation!
====================================
-Contents:
+:Author: Rafael Goncalves Martins
+:Source code: http://hg.rafaelmartins.eng.br/g-octave/
+:Bug tracker: http://g-octave.rafaelmartins.eng.br/
+:Version: |release|
-.. toctree::
- :maxdepth: 2
+.. topic:: Overview
+
+ g-Octave is a tool that generates and installs ebuilds for
+ `Octave-Forge`_ packages "on-the-fly" to `Gentoo Linux`_, using
+ Portage_. It's capable to generate ebuilds and Manifest files for
+ the packages, and to install them using an autogenerated overlay
+ (named g-octave). g-Octave can also handle patches to the packages
+ automatically. The command line interface tries to be very similar
+ to the interface of the *emerge* tool.
+
+.. _`Octave-Forge`: http://octave.sourceforge.net/
+.. _`Gentoo Linux`: http://www.gentoo.org/
+.. _Portage: http://www.gentoo.org/proj/en/portage/
-Indices and tables
-==================
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+Contents
+--------
+
+.. toctree::
+ :maxdepth: 2
+ userguide
+ tinderbox
+ development