2017-07-08 3 views
2

Mon repo est situé sur github ici: https://github.com/AshleySetter/optoanalysisdirective autodoc fonctionne localement, mais pas sur readthedocs

Et les docs sont en https://github.com/AshleySetter/optoanalysis/tree/master/optoanalysis/docs

ReadTheDocs ne manque pas, mais la documentation produite (hébergé ici: https://optoanalysis.readthedocs.io/en/latest/) doesn N'affiche pas les chaînes de document qui doivent être produites par la commande ..autodoc::.

Cependant, il s'exécute correctement localement et affiche la documentation lorsque j'ouvre le fichier build/html/index.html.

Sur ReadTheDocs il ressemble:

READTHEDOCS documentation

Alors que le fichier html construit localement ressemble à ceci:

locally hosted documentation

Pourquoi pourrait-il être?

Répondre

2

Vous avez des modules écrits en Cython et compilés en C. Je pense que ReadTheDocs doesn't support C extensions. Vous devez protéger vos importations pour qu'elles soient générées sur ReadTheDocs.

Quelque chose comme this:

import os 
if 'READTHEDOCS' not in os.environ: 
    import cython_generated_ext 
+0

Merci, qui a résolu le problème. – SomeRandomPhysicist