Cómo instalar Sphinx (Python) en Windows y pequeña guía

Hola! Qué tal todo? Hoy voy a explicar cómo instalar este popular autogenerador de documentación para Python. Decir que instalar esta versión de Sphinx ha sido todo el reto teniendo en cuenta que sólo funciona en la última función de Python.

garden animal leaf lizard
Photo by Edwin Lopez on Pexels.com

Decir también que he intentando instalar esta utilidad con Anaconda y Chocolatey, pero en ninguno de los dos ha tenido éxito. Decir también que a la hora de instalar este tipo de cosas suelen ser mejor en Linux, aunque es cierto que durante el desarrollo de nuestra aplicación o ejecución de la aplicaciçon es mucho más probable que nos den más problemas en el SO libre.

Para instalar la última versión de este lenguaje de programación, simplemente vamos a la página oficial y nos lo descargamos por ahí:

Descargamos la última versión de Python

Instalamos el programa, no nos olvidamos de poner el programa en las variables de entorno.

Instalación

Anted de nada debemos añadir Python en las variables de entorno, una vez hecho esto, podemos seguir.

Para instalar el programa debemos actualizar el gestor de paquetes de Python, es decir, PIP.

python.exe -m pip install --upgrade pip

Instalamos la última versión de nuestro generados de código:

pip install -U sphinx

Por último nos vamos a nuestro proyecto, y escribimos en el CMD:

sphinx-quickstart

Pequeña guía de sphinx

Para hacer documentación correctamente,

  • Deberemos definir las clases, y funciones dentro de nuestro programa, tener claro qué es lo que va a hacer.
  • Definir justo debajo de las funciones y clases entre 3 comillas dobles «»» y «»» nuestro comentario
  • Escribimos «sphinx-quickstart» dentro de la terminal, en el directorio de nuestro proyecto
  • Entramos en conf.py, y quitamos los import os, sys, sys.path.insert(0, os.path.abspath(‘,’))
  • Generamos los ficheros de documentación con «sphinx-apidoc -o <ruta-salida> -o <ruta-documentar>»
  • Compilamos los archivos con «make html«

Pues nada hasta aquí otro tutorial más espero que os haya gustado, que haya sido entretenido, y nada, un saludo y hasta la próxima chao.

Gracias por visitar mi blog de informática, mi nombre es Tomás y soy formador y desarrollador web. Si quiere usted dejarme alguna sugerencia, ayuda o quiere un servicio de formación estoy escuchando ofertas en tomas.gonzalez@infogonzalez.com, en Facebook a https://www.facebook.com/Infogonzalez estoy deseando escucharle. Su duda o sugerencia NO molesta.

Tomas Gonzalez
Este sitio web utiliza cookies, si necesitas más información puedes visitar nuestra política de privacidad    Ver
Privacidad
Creative Commons License
Except where otherwise noted, the content on this site is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
A %d blogueros les gusta esto: