¿Cómo documento las clases sin el nombre del módulo?
Estoy tratando de documentar un paquete de python consphinx
y han generado exitosamente archivos html. El paquete que estoy documentando consiste en un conjunto de*.py
archivos, la mayoría con una clase con un par de archivos que son módulos genuinos con funciones definidas. No necesito exponer el hecho de que cada clase está en un módulo, así que he agregado las adecuadasfrom
declaraciones en el__init__.py
archivo por ejemplo
from base import Base
para que el usuario pueda utilizar elimport pkg
y no tiene que especificar el módulo que contiene la clase:
import pkg
class MyBase(pkg.Base): # instead of pkg.base.Base ...
...
El problema es que la esfinge insiste en documentar la clase comopkg.base.Base
. He intentado configurar eladd_module_names = False
enconf.py
. Sin embargo, esto da como resultado que la esfinge muestre la clase como simplementeBase
en lugar depkg.Base
. Adicionalmente esto también arruina la documentación de la pareja de*.py
archivos queson módulos
Como hagosphinx
mostrar una clase comopkg.Base
? ¿Y cómo configuro eladd_module_names
directiva selectivamente para cada*.py
¿expediente?