corrected sphynx build errors/warnings (close #145530)
authorPaul Tonelli <paul.tonelli@logilab.fr>
Mon, 10 Jun 2013 15:55:37 +0200
changeset 160 7570a911464d
parent 159 eedd0d7cdb0d
child 161 54aa6205c9a4
corrected sphynx build errors/warnings (close #145530)
docs/how-to-build-an-ami.rst
docs/index.rst
docs/upload-images.rst
docs/using-on-local-machine.rst
--- a/docs/how-to-build-an-ami.rst	Mon Jun 10 16:58:40 2013 +0200
+++ b/docs/how-to-build-an-ami.rst	Mon Jun 10 15:55:37 2013 +0200
@@ -18,7 +18,8 @@
    in a Mercurial repository (must be accessible from the cloud
    instance) so that a:
 
-.. sourcecode:: bash
+.. code-block:: bash
+
      user@host:~$ salt-call state.sls variation.sls
 
    will create the machine you want.
--- a/docs/index.rst	Mon Jun 10 16:58:40 2013 +0200
+++ b/docs/index.rst	Mon Jun 10 15:55:37 2013 +0200
@@ -9,9 +9,9 @@
 Contents:
 
 .. toctree::
-   :maxdepth: 2
 
  using-on-local-machine
+ run-it-in-the-cloud
  main-files
  how-it-works
  how-to-build-an-ami
--- a/docs/upload-images.rst	Mon Jun 10 16:58:40 2013 +0200
+++ b/docs/upload-images.rst	Mon Jun 10 15:55:37 2013 +0200
@@ -12,33 +12,39 @@
 
 1. First, add your credentials to path (change ):
 
-.. sourcecode:: bash  
+.. code-block:: bash  
+
   root@machine~# . /${correct_path}/openrc.sh 
 
 2. Then, if necessary, define a name for your ami:
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# export ami_name=variation
 
 3. And change to the correct directory:
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# cd /mnt/output 
 
 4. If necessary, upload the kernel and the ramdisk:
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# glance add is_public=false disk_format=aki container_format=aki \
   name=${ami_name}_kernel < kernel_variation
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# glance add is_public=false disk_format=ari container_format=ari \
   name=${ami_name}_ramdisk < ramdisk_variation
 
 5. Finally, upload the image after replacing the kernel_id and ramdisk_id
    according to the previous uploads:
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# glance add disk_format=ami container_format=ami name="${ami_name}" \
   kernel_id=278de93c-5276-410f-a221-667cc1443cf8 \
   ramdisk_id=b953e40a-2605-402b-8663-c8556a5899f2 < /mnt/variation.img
@@ -58,12 +64,13 @@
 3. transfer the content of the image to the EBS volume (replace xvdf by correct
    device name):
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   ubuntu@machine:~$ sudo dd bs=16M if=/mnt/output/variation.img of=/dev/xvdf
 
 4. Detach the volume, take a snapshot, create an ami image from the amazon ec2
    web interface. Make sure to use the correct "aki" (kernel image) as
    indicated on documentation_ (for eu, use aki-71665e05).
 
-::_from: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html
-::_documentation: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html
+.. _from: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html
+.. _documentation: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html
--- a/docs/using-on-local-machine.rst	Mon Jun 10 16:58:40 2013 +0200
+++ b/docs/using-on-local-machine.rst	Mon Jun 10 15:55:37 2013 +0200
@@ -14,17 +14,20 @@
 
 On Ubuntu, the first step is to add the salt PPA to install it:
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# add-apt-repository -y ppa:saltstack/salt
 
 The next step is to install salt-minion and mercurial:
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# aptitude update && aptitude install salt-minion mercurial
 
 On CentOS, enable EPEL and install salt-minon & mercurial : 
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# wget http://dl.fedoraproject.org/pub/epel/5/x86_64/epel-release-5-4.noarch.rpm
   root@machine~# rpm -Uvh epel-release-5-4.noarch.rpm
   root@machine~# yum install salt-minion mercurial
@@ -32,17 +35,20 @@
 
 Then, clone the server repository:
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# hg clone http://hg.logilab.org/master/salt-ami-cloud-builder/ /etc/salt/srv
 
 Copy the necessary scripts so the ami creation process is launched at boot:
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# cp /etc/salt/srv/others/rc.local /etc/rc.local
 
 and copy the configuration to make salt-minion masterless:
 
-.. sourcecode:: bash
+.. code-block:: bash
+
   root@machine~# cp /etc/salt/srv/minion /etc/salt/
 
 save this machine as an ami-creator image and you can then use it by simply