ABSOLUTELY NO WARRANTY | free software

# find

Comandos principales

>>> sphinx-quickstart
>>> make html

Sintáxis

Niveles de titulos:

*****            (capítulo)
#####            (sección)
=====            (titulo)
-----            (subtitulo)
^^^^^            (subsubtitulo)

Atributos de fuente:

*cursiva*
**negrita**
``codigo``

Listas:

* item de lista.
* mas items.
    * Elemento interno de la lista.

1. item de lista enumerado.
2. segundo elemento.
#. tercer item de la lista.

Definiciones:

Elemento
    Descripción detallada.

Ejemplos:

deben comenzar con dos puntos seguidos, y lo siguiente debe estar identado, por ejemplo:

Veamos un ejemplo:

import pygame

Listas de campos:

:Author: Gcoop
:Versión: 0.1
:Fecha edición: 10 de Junio del 2009

Enlaces:

SugarCRM

Enlaces internos:

nombre del titulo :mod:`os` :ref:`lista`

System Message: ERROR/3 (data/sphinx-howto.txt, line 66); backlink

Unknown interpreted text role "mod".

System Message: ERROR/3 (data/sphinx-howto.txt, line 66); backlink

Unknown interpreted text role "ref".

Destino de vinculo interno:

.. _lista:

Lista de opciones para programas comando:

-a           muestra todos los archivos, incluso ocultos.
-l           usa un formato de lista extenso.

Bloques literales:

Utilice ``::`` y luego una identación para incluir texto
en crudo.

Bloques en linea:

| Se resperarán
| los saltos de linea.

Referencias:

Este es un texto con nota al pie [1] y puede citarse en cualquier parte.

Vínculos:

Puede citar proyectos como GNOME y luego indicar sus web.

Notas al pie:

Cite el proyecto [GNU] y la cita luego al pie.

Referencias internas:

Tiene que indicar el termino y mas adelante, en otro párrafo indicar el destino para llegar.

Este es el parrafo destino del vinculo.

Directivas especiales de Sphinx:

Note

message.

Warning

message.

System Message: ERROR/3 (data/sphinx-howto.txt, line 139)

Unknown directive type "seealso".

.. seealso::
    links.

Descripción de la clase, sus responsabilidades y tareas.

System Message: ERROR/3 (data/sphinx-howto.txt, line 146)

Unknown directive type "method".

.. method:: get_name()

System Message: ERROR/3 (data/sphinx-howto.txt, line 151)

Unknown directive type "module".

.. module:: re
   :synopsis: Support for regular expressions (RE)

System Message: ERROR/3 (data/sphinx-howto.txt, line 154)

Unknown directive type "function".

.. function:: str(object) -> string
       Return a nice string representation of the object

       :param object: objeto que se quiere representar.
       :type object: cualquier objecto de python.
       :rtype: una cadena.

.. glossary::

    Término
        Definición del término citado.

Comentarios