Blog
Documentación con Sphinx para Django usando Virtualenv
Camilo Nova
Camilo Nova
CEORecientemente 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:
#!/bin/bash
export PYTHONPATH=$PYTHONPATH:${PWD%/*/*}:${PWD%/*}
export DJANGO_SETTINGS_MODULE=miproyecto.settings
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.
Written by Camilo Nova
Camilo Nova
Axiacore CEO. Camilo writes thoughts about the intersection between business, technology, and philosophy
Scale your company with the same people
Practical ideas to do more and get back your time every week
We respect your inbox. Privacy policy