Como_Ayudar.rst

COMO HACER DOCUMENTOS .RST PARA EL MANUAL

La guía del usuario de Kumbiaphp usa Sphinx para gestionar la documentación y salida a varios formatos. Las páginas están escritas en ReStructured Text format.

Creando un fork

Desde Github puedes crear un fork a este proyecto, así tendrás tu propio repo. Puedes editar tu repo y cargar el contenido que desees, una vez cargado haces commit, pull y push para subirlo a tu github.

• Actualizando el repo principal: Desde github y en tu repo realiza un pull-request de tu repo hacia este.
• Actualizando el tu repo: Desde github y tu repo realiza un pull-request desde el principal a tu repo.

Como crear un .rst

Para crear un .rst puedes hacerlo desde cualquier editor de texto, además puedes editarlos y ver la vista previa desde github

Códigos básicos del .rst

Todos los archivos deben terminar en .rst

• Creando un nuevo contenido

En el archivo source/index.rst ingresas el nombre del archivo de la siguiente manera

*********
Categoria
*********

- :doc:`carpeta/archivo1`
- :doc:`carpeta/archivo2`

Al compilarlo automáticamente tomará el título del archivo y lo indicará en el index para formar la tabla de contenido.

• Creando un título

############################
Este es un titulo de un tema
############################

• Creando un subtítulo

*******************************
Este es un subtitulo de un tema
*******************************

• Creando un subtítulo de 2 nivel

---------------------------------
Este es un titulo de un subtitulo
---------------------------------

• Escribiento en itálica:

*Hola Mundo*

• Escribiento en negrita:

**Hola Mundo**

• Resaltando una palabra o código simple. Ejemplo sudo service apache2 restart

``sudo service apache2 restart``

• Creando bloque de php

.. code-block:: php

<?php

class Hola extends ActiveRecord {

}

• Creando bloque de html

.. code-block:: html

<div class="row">
    <div class="col-md-6>
        <h1>Hola Mundo!</h1>
    </div>
</div>

• Creando bloque de Javascript

.. code-block:: javascript

(function($) {
      $(document).ready(function() {
            ... do stuff here ...
      })
 })(jQuery);

• Creando bloque de CSS

.. code-block:: css

h1 { margin-top: 5px; }
.example { font-size: 1.2em }