Documentación con Sphinx para Django usando Virtualenv

Documentación con Sphinx para Django usando Virtualenv
Recientemente hemos comenzado a usar Sphinx para la documentación de los proyectos de AxiaCore, en especial funciona muy bien con Django, pero tuve algunos problemas al hacer funcionar la extensión autodoc que permite obtener las cadenas de documentación del código fuente, esto porque los proyectos ahora los manejamos con virtualenv. La manera en que lo hice funcionar fue con el siguiente script hecho en casa:
  1. #!/bin/bash
  2. export PYTHONPATH=$PYTHONPATH:${PWD%/*/*}:${PWD%/*}
  3. export DJANGO_SETTINGS_MODULE=miproyecto.settings
  4. make html SPHINXBUILD='../../bin/sphinx-build'
Para mi configuración, yo tengo una carpeta doc en la raíz del proyecto donde reside mis archivos de sphinx, allí debe haber un archivo Makefile, allí debes crear el script y al correrlo, el utilizará el sphinx de virtualenv y habilitará las variables necesarias para obtener la documentación del código fuente. Espero les sea de ayuda.

En promedio nuestros portales tienen 99% de uptime

Suena bien

Hemos trabajado con estas marcas, la tuya es la siguiente?

  • FOX
  • Activia
  • OndadeMar
  • Ministerio de agricultura

Nueva York

50 West. 72nd Street. NY 10023
+1 646 688 2356

Londres

145-157 St John Street. EC1V 4PW
+44 07751 092 425

Bogotá

Cll 100 # 14 - 63 OF 801
+57 (1) 7047348 | +57 (1) 2360310