yellow team mailing list archive

[Nicola Larosa <nicola.larosa@xxxxxxxxxxxxx>]

Reviewers: mp+132511_code.launchpad.net,

Message:
Please take a look.

Description:
Add the README to the docs.

Add the README to the docs by symlinking it from the docs directory,
integrating it into the docs index, and adjusting it to better fit
with the rest.

https://code.launchpad.net/~teknico/juju-gui/add-readme-to-docs/+merge/132511

(do not edit description out of merge proposal)


Please review this at https://codereview.appspot.com/6820071/

Affected files:
   M README
   A [revision details]
   M docs/index.rst


Index: README
=== modified file 'README'
--- README	2012-10-31 10:57:16 +0000
+++ README	2012-11-01 10:56:56 +0000
@@ -1,3 +1,7 @@
+======
+README
+======
+
  Developer Install
  =================

@@ -9,7 +13,7 @@
    $ sudo apt-get update
    $ sudo apt-get install nodejs npm

-You also need ImageMagick.
+You also need ImageMagick::

    $ sudo apt-get install imagemagick

@@ -102,7 +106,18 @@

    $ jshint --config=jshint.config `bzr ls -RV -k file | grep -v assets/`

-Style
-=====
-
-See the ``docs/style-guide.rst`` file for the project style guide.
+More documentation
+==================
+
+Install Sphinx::
+
+  $ sudo apt-get install python-sphinx
+
+Build the docs::
+
+  $ cd docs
+  $ make html
+
+View them::
+
+  $ xdg-open _build/html/index.html


Index: [revision details]
=== added file '[revision details]'
--- [revision details]	2012-01-01 00:00:00 +0000
+++ [revision details]	2012-01-01 00:00:00 +0000
@@ -0,0 +1,2 @@
+Old revision: gary.poster@xxxxxxxxxxxxx-20121101100931-twuuqm2co96dr91g
+New revision: nicola.larosa@xxxxxxxxxxxxx-20121101105656-t1b7yzjol8nictce

Index: docs/index.rst
=== modified file 'docs/index.rst'
--- docs/index.rst	2012-10-05 09:42:27 +0000
+++ docs/index.rst	2012-11-01 10:56:56 +0000
@@ -11,8 +11,9 @@
  .. toctree::
     :maxdepth: 2

+   readme
+   style-guide
     architecture
-   style-guide
     process

  Indices and tables

=== added symlink 'docs/readme.rst'
=== target is u'../README'




-- 
https://code.launchpad.net/~teknico/juju-gui/add-readme-to-docs/+merge/132511
Your team Juju GUI Hackers is requested to review the proposed merge of lp:~teknico/juju-gui/add-readme-to-docs into lp:juju-gui.