Getting Started — Read The Docs 1.0 documentation This document will show you how to get up and running with Read the Docs. If you are already using Sphinx for your docs, skip ahead to Import Your Docs. There is a screencast that will help you get started if you prefer. Write Your Docs¶ Install Sphinx, and create a directory inside your project to hold your docs: $ cd /path/to/project $ mkdir docs Run sphinx-quickstart in there: $ cd docs $ sphinx-quickstart This will walk you through creating the basic configuration; in most cases, you can just accept the defaults. Now, edit your index.rst and add some information about your project. Edit your files and rebuild until you like what you see, then commit your changes and push to your public repository. Import Your Docs¶ Sign up for an account on RTD, then log in. Git: lp:pasta Add an optional homepage URL and some tags, then click “Create”.
Documentación fácil y atractiva con Sphinx Introducción Sphinx es una herramienta que permite a los desarrolladores escribir documentos en texto plano para una fácil generación de salidas en formatos que satisfagan diversas necesidades. Esto se vuelve útil usando un Sistema de Control de Versiones para realizar el seguimiento de los cambios. La documentación de texto plano también es útil para colaboradores a través de distintos sistemas. El texto plano es uno de los formatos más portables disponibles actualmente. Aunque Sphinx está escrito en Python y fue originalmente creado para la documentación del lenguaje de Python, no está centrado necesariamente en el lenguaje y, en algunos casos, ni siquiera es específico del programador. Piense en Sphinx como una infraestructura de documentación: abstrae las partes tediosas y ofrece funcionalidad automática para solucionar problemas comunes como el indexado de títulos y el resaltado de código especial (si se están mostrando ejemplos de código) con el resaltado de sintaxis apropiado.