将构建Sphinx文档添加到Python Wheel

时间:2018-09-06 09:52:07

标签: python python-sphinx

我正在创建一个包装(并捆绑)DLL的Python程序包。我正计划在车轮内运送基于预构建的狮身人面像的文档,并可能添加一个入口点,以方便启动浏览器以查看它们。

经过一番谷歌搜索后,我没有找到有关此方法的太多信息。

这不是推荐的方法吗?请注意,这是针对内部软件包,而不是供公众使用,我希望软件包用户始终具有DLL版本的相应文档版本。

我正在寻找的是一种通过在setup.py文件中引用它们来包含内置html文件的方法。我知道我可以在package_data内对include_package_data使用setupsetup.py关键字参数,但是我相信这些名称可以与包一起使用,所以我认为使用这种方法会麻烦这个应用程序。

如果这不是正确的方法,我很想听到更好的选择!

1 个答案:

答案 0 :(得分:0)

我已经确定了一个使用data_files似乎可以正常工作的解决方案,但是这很丑陋。该解决方案基于此answer

在我的setup.py中,我有这个:

def get_data_files(docs_root):
    data_files = []
    for dirname, dirs, files in os.walk(docs_root):
        for f in files:
            data_files.append(os.path.join(dirname, f))
    return data_files

我称为data_files关键字参数的一部分:

data_files = [('Lib/site-packages/<module_name>/docs', get_data_files('module_name/docs'))],

对于此功能的可移植性,我有所保留,但这似乎是唯一适用于我的可行选项,它也允许进行干净的卸载。