¿Cómo puedo configurar Read the Docs para que la opción Sphinx autodoc funcione?

Mi proyecto no está construyendo con autodoc. Me encuentro con esta pregunta frecuente sobre mi proyecto que no se construye en autodoc . Sin embargo, algunas de las dependencies incluyen código c que no se ejecutará en los serveres Build the Docs. Así que leí el enfoque en este blog explicando que debería usar simulacro . Esto se relaciona con la pregunta de stackoverflow 'how-to-mock-so-that-from-x-import-works'.

En la sección de configuration avanzada de la página de administración en Leer los documentos, hay una opción para usar virtualenv, que he comprobado, y luego se solicita la ruta a la raíz de mi proyecto a requirements.txt.

El directory del proyecto está estructurado como:

GatherNews/ requirements.txt 

Cuando uso "GatherNews / requirements.txt" como la ruta. Me sale el error:

/var/build/user_builds/gathernews/checkouts/latest/docs/api/grss.rst:10: ADVERTENCIA: autodoc: no se pudo importar la class u'CaptureFeeds 'del module u'gathernews.gRSS'; la siguiente exception fue planteada:

Rastreo (llamadas recientes más última):

Archive "/home/docs/checkouts/readthedocs.org/user_builds/gathernews/envs/latest/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", línea 335, en import_object import (self .modname)

Archivo "/home/docs/checkouts/readthedocs.org/user_builds/gathernews/envs/latest/local/lib/python2.7/site-packages/gathernews/ init .py", línea 1, en importar gRSS

Archivo "/home/docs/checkouts/readthedocs.org/user_builds/gathernews/envs/latest/local/lib/python2.7/site-packages/gathernews/gRSS.py", línea 38, en el feedparser de import

ImportError: Ningún module llamado feedparser /var/build/user_builds/gathernews/checkouts/latest/docs/_themes/README.rst :: ADVERTENCIA: el documento no está incluido en ningún tree

Mi pregunta es ¿cómo ato todo esto? Específicamente, ¿estoy usando la ruta correcta a mis requirements.txt para leer los documentos para build con éxito? Si mi ruta a mis requirements.txt es correcta, ¿cómo puedo include el package simulado para generar autodocs con éxito?

Creé un tenedor de https://github.com/Bonza-Times/GatherNews y un set de ReadTheDocs para él. El único problema parece ser que utilizó la ruta incorrecta a requirements.txt . Dice

Ruta desde la raíz de su proyecto.

así que eso no incluye GatherNews . Simplemente use requirements.txt como la ruta, ya que ese file está en el nivel superior de su repository de git.

Como tiene verificado Use virtualenv , ReadTheDocs se encargará automáticamente de asegurarse de que los packages de sitio de virtualenv estén disponibles en sys.path para el script sphinx-build .

No veo ninguna necesidad de modules de burla, ya que feedparser no tiene dependencies duras en las bibliotecas de C. Se puede comstackr contra libxml2, pero no tiene que ser así.

Con la ruta a requirements.txt corregida, pude hacer una compilation exitosa.

Estas son las "Configuraciones Avanzadas" que utilicé, las configuraciones restantes están en valores pnetworkingeterminados:

Ajustes avanzados

    Intereting Posts