Documentación con Sphinx para Django usando Virtualenv

CN Camilo Nova Camilo Nova

Camilo Nova

CEO
1 min read.

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:

#!/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

CN Camilo Nova Camilo Nova

As the Axiacore CEO, Camilo writes about the intersection of technology, design, and business. With a strategic mindset and a deep understanding of the industry, he is dedicated to helping companies grow.

Newsletter

Subscribe to our newsletter:

Read more

Migrar repositorio SVN a GIT

Estos son los pasos para realizar la migración de un repositorio subversion a git:# Creamos el repositorio en el servidor rem...

1 min read.

Visualización THD

Aquí tenemos otra visualización de nuestro trabajo al desarrollar proyectos, en esta oportunidad fue un proyecto de dos meses...

1 min read.

Build Once. Own Forever.