Updated various docs to rst/genshi.

fijal · Feb 16, 2010 · 734dbbe · 734dbbe
1 parent 9d315d6
commit 734dbbe
Show file tree

Hide file tree

Showing 13 changed files with 319 additions and 216 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -4,22 +4,24 @@ Ampify Authors
 This is the official list of the Ampify Authors ("The Contributors"), listed in
 alphabetical order:
 
++----------------------------+--------------------+--------------------------+----------------+
 | Name                       | Nick               | Email                    | Country        |
-|----------------------------|--------------------|--------------------------|----------------|
-| [James Arthur]             | thruflo            | <[email protected]> | U.K.           |
++----------------------------+--------------------+--------------------------+----------------+
+| `James Arthur`_            | thruflo            | <[email protected]> | U.K.           |
 | Maciej Fijalkowski         | fijal              | <[email protected]>       | Poland         |
-| [Mamading Ceesay]          | evangineer         | <[email protected]>     | U.K.           |
+| `Mamading Ceesay`_         | evangineer         | <[email protected]>     | U.K.           |
 | Mathew Ryden               | oierw              | <[email protected]>       | U.S.A.         |
-| [Sean B. Palmer]           | sbp                | <[email protected]>    | U.K.           |
-| [Tav]                      | tav                | <[email protected]>        | U.K.           |
+| `Sean B. Palmer`_          | sbp                | <[email protected]>    | U.K.           |
+| `Tav`_                     | tav                | <[email protected]>        | U.K.           |
++----------------------------+--------------------+--------------------------+----------------+
 
-[James Arthur]: http://thruflo.com
-[Mamading Ceesay]: http://twitter.com/evangineer
-[Sean B. Palmer]: http://inamidst.com
-[Tav]: http://tav.espians.com
+.. _James Arthur: http://thruflo.com
+.. _Mamading Ceesay: http://twitter.com/evangineer
+.. _Sean B. Palmer: http://inamidst.com
+.. _Tav: http://tav.espians.com
 
 By adding yourself to this list, you explicitly agree to affirm all of your
 Contributions to the Public Domain according to the Public Domain license that
-can be found in the root [LICENSE] file.
+can be found in the root `LICENSE`_ file.
 
-[LICENSE]: license.html
+.. _LICENSE: license.html
diff --git a/doc/README.md b/doc/README.md
@@ -2,22 +2,11 @@ This directory contains the documentation for the Ampify platform.
 
 You can also view the documentation online at:
 
-* [http://code.ampify.it](http://code.ampify.it)
+* [http://dev.ampify.it](http://dev.ampify.it)
 
-The documentation site is automatically generated from the `*.md` source
-[Markdown](http://daringfireball.net/projects/markdown/) files using
-[Jekyll](http://github.com/mojombo/jekyll), a static site generator written in
-Ruby.
+The documentation site is automatically generated from the `*.txt` source
+[reStructuredText](http://docutils.sourceforge.net/rst.html) files using
+Yatiblog, a static site generator that can be found in `environ/startup`.
 
-If you want the documentation as HTML files for offline use, you can install
-Jekyll for yourself using:
-
-    $ sudo gem install jekyll
-
-You also need to install the [Pygments](http://pygments.org/) syntax highlighter
-for your system Python using something like:
-
-    $ sudo easy_install Pygments
-
-You can then generate the `_site` HTML files by just running `jekyll` in this
-directory.
+If you want the documentation as HTML files for offline use, you can generate
+the `website` HTML files by just running `yatiblog` in this directory.
diff --git a/doc/_config.yml b/doc/_config.yml
@@ -3,6 +3,6 @@ site_description: The Ampify Platform
 site_license: Public Domain
 site_title: Ampify
 site_url: http://code.ampify.it
+
 index_pages:
-- feed.rss: feed.genshi
 - archive.html: archive.genshi
diff --git a/doc/_layouts/page.html → doc/_layouts/page.genshi b/doc/_layouts/page.html → doc/_layouts/page.genshi
@@ -3,5 +3,5 @@
 ---
 
 <div class="page">
-{{content}}
+${Markup(content)}
 </div>
diff --git a/doc/_layouts/rawtext.html b/doc/_layouts/rawtext.html
diff --git a/doc/_layouts/site.html → doc/_layouts/site.genshi b/doc/_layouts/site.html → doc/_layouts/site.genshi
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Ampify :: {{page.title}}</title>
+  <title>Ampify :: ${title}</title>
   <meta content="text/html; charset=utf-8" http-equiv="content-type" />
   <link rel="stylesheet" type="text/css" title="default" href="css/style.css" />
   <script type="text/javascript" src="http://use.typekit.com/hdt8sni.js"></script>
@@ -32,7 +32,7 @@
   </div>
 </div>
 <div id="content">
-{{content}}
+${Markup(content)}
 </div>
 <div id="footer">
 </div>

diff --git a/doc/credits.txt b/doc/credits.txt
@@ -1,5 +1,6 @@
 ---
 layout: page
+title: Credits
 ---
 
 Credits

diff --git a/doc/history.txt b/doc/history.txt
@@ -1,10 +1,15 @@
 ---
 layout: page
+title: History
 ---
 
 History
 =======
 
+**2010-02-16**
+
+* The architecture for an "Ampify Zero" is finalised.
+
 **2010-01-17**
 
 * Sean B. Palmer wrote the very first public article about Ampify: "`Ampify, a
@@ -40,7 +45,7 @@ History
 **2009-08-18**
 
 * With help from David Pinto, Tav coded a prototype version of the collaboration
-  platform called `Tent <http://tent.espians.com`_. It added micro syntax and
+  platform called `Tent <http://tent.espians.com>`_. It added micro syntax and
   structured search to facilitate collaboration over IRC.
 
 **2009-08-14**

diff --git a/doc/index.txt b/doc/index.txt
@@ -1,19 +1,20 @@
 ---
-layout: index
+layout: page
 title: Documentation
 ---
 
 Ampify
 ======
 
-* Table of Contents
-{:toc}
+.. contents::   Table of Contents
+                :depth: 1
+                :backlinks: none
 
 The Ampify Platform aims to allow for micro-data powered application
 development. The goal for the 1.0 release is to have a fully decentralised
 platform, but right now we're working on creating version `Zero`.
 
-Have a read of the [ Zero Architecture](zero-architecture.html).
+Have a read of the planfile for `Ampify Zero <planfile.html>`_.
 
 
 Get Started
@@ -22,89 +23,91 @@ Get Started
 You need to have Git, a recent Python 2.x and general dev tools (gcc, make,
 etc.) installed.
 
-{% highlight bash %}
-# clone the source repository.
-$ git clone git://github.com/tav/ampify.git
+.. syntax:: bash
 
-# setup ampify related environment variables using the ampenv.sh bash script.
-# you might also want to add this line to your ~/.profile or ~/.bashrc files.
-$ source ampify/environ/startup/ampenv.sh
+  # clone the source repository.
+  $ git clone git://github.com/tav/ampify.git
 
-# use the new git update command which will now be on your $PATH to keep the
-# repository updated from now on — it also inits and updates git submodules.
-$ cd ampify
-$ git update
+  # setup ampify related environment variables using the ampenv.sh bash script.
+  # you might also want to add this line to your ~/.profile or ~/.bashrc files.
+  $ source ampify/environ/startup/ampenv.sh
 
-# configure your build (and verify you have the necessary dependencies).
-$ cd src
-$ ./configure
+  # use the new git update command which will now be on your $PATH to keep the
+  # repository updated from now on — it also inits and updates git submodules.
+  $ cd ampify
+  $ git update
 
-# build various aspects of the ampify platform and verify everything works by
-# running the tests.
-$ make test
-{% endhighlight %}
+  # configure your build (and verify you have the necessary dependencies).
+  $ cd src
+  $ ./configure
+
+  # build various aspects of the ampify platform and verify everything works by
+  # running the tests.
+  $ make test
 
 
 Get Involved
 ------------
 
-* Come by and say hello and introduce yourself on
-  [IRC](irc://irc.freenode.net/esp):
+* Come by and say hello and introduce yourself on `IRC
+  <irc://irc.freenode.net/esp>`_:
+
+.. raw:: html
 
-<pre>
-server: irc.freenode.net
-channel: #esp
-chatlogs: <a href="http://irclogs.ampify.it">irclogs.ampify.it</a>
-</pre>
+  <pre>
+  server: irc.freenode.net
+  channel: #esp
+  chatlogs: <a href="http://irclogs.ampify.it">irclogs.ampify.it</a>
+  </pre>
 
-* Get on the [ampify-dev](http://groups.google.com/group/ampify-dev) mailing
+* Get on the `ampify-dev <http://groups.google.com/group/ampify-dev>`_ mailing
   list.
 
-* Sign up to GitHub if you don't have an
-  [account](https://github.com/signup/free) — it takes just a minute! You can
-  then [fork](http://help.github.com/forking/) the [ampify
-  repository](http://github.com/tav/ampify) and send [pull
-  requests](http://github.com/guides/pull-requests) with any changes you might
-  have.
+* Sign up to GitHub if you don't have an `account
+  <https://github.com/signup/free>`_ — it takes just a minute! You can then
+  `fork <http://help.github.com/forking/>`_ the `ampify repository
+  <http://github.com/tav/ampify>`_ and send `pull requests
+  <http://github.com/guides/pull-requests>`_ with any changes you might have.
 
-{% highlight bash %}
-$ git clone [email protected]:yourUsername/ampify.git
-$ git remote add upstream git://github.com/tav/ampify.git
-{% endhighlight %}
+.. syntax:: bash
 
-* Read the [getting started with
-  git](http://www.espians.com/getting-started-with-git.html) guide for Ampify
+  $ git clone [email protected]:yourUsername/ampify.git
+  $ git remote add upstream git://github.com/tav/ampify.git
+
+* Read the `getting started with git
+  <http://www.espians.com/getting-started-with-git.html>`_ guide for Ampify
   Developers if you're new to git.
 
 * Familiarise yourself with the Ampify testing and review process.
 
-{% highlight bash %}
-# commit your changes to your local repository.
-$ git commit
+.. syntax:: bash
+
+  # commit your changes to your local repository.
+  $ git commit
 
-# submit an issue to be reviewed on http://codereview.appspot.com — running this
-# also checks with appropriate local revhooks before your submission is made.
-$ git review submit 
+  # submit an issue to be reviewed on http://codereview.appspot.com — running this
+  # also checks with appropriate local revhooks before your submission is made.
+  $ git review submit 
 
-# make any changes and keep committing and submitting updates on the issue until
-# the reviewers give a LGTM (Looks Good To Me) reply.
+  # make any changes and keep committing and submitting updates on the issue until
+  # the reviewers give a LGTM (Looks Good To Me) reply.
 
-# once you have an okay, squash your various commits into a single commit and
-# push to the remote repository.
-$ git review push
-{% endhighlight %}
+  # once you have an okay, squash your various commits into a single commit and
+  # push to the remote repository.
+  $ git review push
 
 
 General Info
 ------------
 
-* [AUTHORS](authors.html) — A listing of those who have directly contributed
+* `AUTHORS <authors.html>`_ — A listing of those who have directly contributed
   code/documentation to Ampify.
 
-* [CREDITS](credits.html) — A listing of those who have contributed indirectly.
+* `CREDITS <credits.html>`_ — A listing of those who have contributed
+  indirectly.
 
-* [HISTORY](history.html) — A brief history of Ampify.
+* `HISTORY <history.html>`_ — A brief history of Ampify.
 
-* [LICENSE](license.html) — The Public Domain License for the Ampify platform.
+* `LICENSE <license.html>`_ — The Public Domain License for the Ampify platform.
 
-* [TODO](todo.html) — The current set of Priority Todo items.
+* `PLANFILE <planfile.html>`_ — The current planfile for Ampify Zero.