python-spinx命令缺少conf文件

我在运行tox命令来为我的Python项目生成Shpinx文档时遇到问题.这是错误.

docs runtests: PYTHONHASHSEED='1181019260'
docs runtests: commands[0] | sphinx-build -W -b html -c ./conf.py -d /Users/rakesh.kumar/ll/client-location/limekiln/.tox/docs/tmp/doctrees . /Users/rakesh.kumar/ll/client-location/limekiln/.tox/docs/tmp/html
Error: Config directory doesn't contain a conf.py file.
ERROR: InvocationError: '/Users/rakesh.kumar/ll/client-location/limekiln/.tox/docs/bin/sphinx-build -W -b html -c ./conf.py -d /Users/rakesh.kumar/ll/client-location/limekiln/.tox/docs/tmp/doctrees . /Users/rakesh.kumar/ll/client-location/limekiln/.tox/docs/tmp/html'
_________________________________________________ summary __________________________________________________
  py27: commands succeeded
  lint: commands succeeded
ERROR:   docs: commands failed

基本上,它抱怨conf.py,但是此配置文件存在于tox.ini所在的目录中.我是Tox和Sphinx的新手,不知道为什么会抱怨.
这是tox.ini的内容.

[tox]
envlist = py27,lint,docs

[testenv]
commands =
    python setup.py nosetests --with-coverage --cover-package=limekiln --cover-erase --cover-html
    python setup.py sdist
deps =
    setuptools>=17.1

[testenv:docs]
basepython=python
changedir=docs
deps=sphinx
commands=
    sphinx-build -W -b html -c ./conf.py -d {envtmpdir}/doctrees .  {envtmpdir}/html

[testenv:lint]
commands=flake8 --max-line-length 99 limekiln
basepython=python2.7
deps=
    flake8
    flake8-print

这是我的conf.py文件.

import sys, os

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

extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo',
                    'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig',
                                  'epub2', 'mobi', 'autoimage', 'code_example', 'sphinx.ext.autodoc']

todo_include_todos = True
templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
exclude_patterns = []
add_function_parentheses = True
#add_module_names = True
#modindex_common_prefix = []

project = u'Limekiln'
copyright = u'2015'

version = '1.0'
release = '1.0'

这是我的项目的目录结构.

Project-root-directory
├── conf.py
├── module directory
│   ├── module sub-directory1
│   ├── module sub-directory2
├── requirements.txt
├── setup.py
└── tox.ini

解决方法:

更改

commands=
sphinx-build -W -b html -c ./conf.py -d {envtmpdir}/doctrees .  {envtmpdir}/html

至

commands=
sphinx-build -W -b html -c ./ -d {envtmpdir}/doctrees .  {envtmpdir}/html

从sphinx-build帮助：

-c <path>           path where configuration file (conf.py) is located

标签：tox,python-sphinx,python
来源： https://codeday.me/bug/20191027/1947659.html