Sphinx не находит ни одного из моих модулей после make html - PullRequest
1 голос
/ 16 февраля 2020

Когда я пытаюсь сгенерировать свою документацию с помощью Sphinx, сгенерированные htmls пусты, потому что sphinx не находит ни один из моих модулей. Это дерево моего репозитория:

├── docs
│   ├── _build
│   ├── common.rst
│   ├── conf.py
│   ├── imputation.rst
│   ├── index.rst
│   ├── main.rst
│   ├── make.bat
│   ├── Makefile
│   ├── modules.rst
│   ├── preprocessing.rst
│   ├── _static
│   └── _templates
├── LICENSE
├── README.md
├── RecommendationEngine
│   ├── common.py
│   ├── **datos**
│   │   ├── tmdb_5000_credits.csv
│   │   └── tmdb_5000_movies.csv
│   ├── **imputation.py**
│   ├── **main.py**
│   ├── **preprocessing.py**
│   └── __pycache__
│       ├── common.cpython-36.pyc
│       ├── imputation.cpython-36.pyc
│       ├── main.cpython-36.pyc
│       └── preprocessing.cpython-36.pyc
└── setup.py

Моя конфигурация пути Sphinx выполняется следующим образом:

import os
import sys
sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('..'))

В большинстве ответов на подобные вопросы это решает проблему. Но когда я выполняю make html, возвращается:

make html
Running Sphinx v2.4.1
loading translations [es]... done
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 5 changed, 0 removed
reading sources... [100%] preprocessing                                                                
WARNING: autodoc: failed to import module 'common'; the following exception was raised:
No module named 'common'
WARNING: autodoc: failed to import module 'imputation'; the following exception was raised:
No module named 'imputation'
WARNING: autodoc: failed to import module 'imputation' from module 'src'; the following                                    exception was raised:
No module named 'src'
WARNING: autodoc: failed to import module 'main'; the following exception was raised:
No module named 'main'
WARNING: autodoc: failed to import module 'preprocessing'; the following exception was         raised:
No module named 'preprocessing'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/gonzalo/tfmunir/RecommendationEngine/docs/modules.rst:         WARNING: document isn't included in any toctree
done

И сгенерированная документация полностью пуста.

Заранее спасибо.

1 Ответ

0 голосов
/ 17 февраля 2020

Вероятно, это можно решить, включив следующую строку в conf.py:

sys.path.insert(0, os.path.abspath(os.path.join('..','RecommendationEngine')))
...