Tutorial rápido: Publicar en Read the Docs

Note

Read the Docs Community es gratuito. También existe una versión de pago: Read the Docs for Business.

Requisitos

• Cuenta en GitHub

• Cuenta en Read the Docs

—

1. Crear el repositorio

1. Inicia sesión en GitHub.

2. Ve al siguiente link.

3. Haz clic en Use this template > Create a new repository.

4. Ajusta lo siguiente: - Nombre: Así se llamará tu repositorio. - Visibilidad: selecciona Público.

5. Haz clic en Create repository.

—

2. Importar el proyecto

1. En Read the Docs, haz clic en Import a Project.

2. Busca el nombre de tu proyecto y haz clic en el icono +. (Si no aparece, presiona refresh your repositories).

3. Completa los detalles y haz clic en Next.

—

3. Verificar la compilación

1. Haz clic en Your documentation is building.

2. Cuando termine, haz clic en View docs para ver el sitio publicado.

—

4. Actualizar proyecto

1. Ve al proyecto en Read the Docs.

2. Selecciona tu proyecto.

3. Abre la pestaña Builds.

4. Presiona Rebuild version.

—

Crear cuenta en Read the Docs

1. Ve a la página de registro.

2. Haz clic en Sign up with GitHub.

3. Autoriza la app con Authorize readthedocs.

   

   Note

   Se solicitan permisos para instalar webhooks.

4. Confirma tu correo y nombre de usuario. Luego haz clic en Sign Up.

   

Sintaxis de escritura

Negritas

• Usando asteriscos dobles: Texto en negritas.

Cursivas (Italics)

• Usando asteriscos simples: Texto en cursiva.

Código/monospace

• Usando doble comillas invertidas: print("Hola mundo.").

Títulos y secciones

• Nivel 1 (título principal):

  Título Principal
  ================
  

• Nivel 2 (subtítulo):

  Subtítulo
  ---------
  

• Nivel 3 (Notas):

  .. note::
     Tu texto aqui
  

Note

Nota bonita.