关注分享主机优惠活动
国内外VPS云服务器

我可以使用 Python setup.py 生成文档吗?

python setup.py 该命令主要用于从源代码创建和安装 Python 包。 文档不是直接生成的。 但是,您可以使用与 setup.py 相关的多种工具生成文档。

一种方法是使用sphinxsetuptools(或distutils)来记录您的项目。产生。 首先,确保您已安装sphinx。 然后将以下行添加到 setup.py 文件中:

来自  setuptools 导入 设置, find_packages

# 添加文档生成命令
来自 sphinx setup_command 导入 BuildDoc

class CustomBuildDoc (BuildDoc):
 user_options = []

 def initialize_options(自我):
 超级().initialize_options()

  def  运行(self):
 # 此处调用Sphinx文档生成命令
 self.do_build()

setup(
  name='包名称',
 version='0.1',
packages=find_packages ( ),
 cmdclass={'build_doc':  CustomBuildDoc},
)

您现在可以运行 python setup.py build_doc 命令生成文档。

另一种方法是使用setuptools_scm自动生成版本信息并将其包含在文档中。 首先,安装setuptools_scm

pip install setuptools_scm

然后将以下行添加到 setup.py 文件中。

来自设置工具导入设置,find_packages
来自 setuptools_scm 导入 get_version

setup(
 name ='包名',
 use_scm_version={
 'write_to': 'your_package/version.py',
 } ,
 package=find_packages(),
)

这将导致your_package/version.py 文件包含版本信息。 您可以使用此文件来更新文档中的版本信息。

综上所述,python setup.py本身无法生成文档,但可以与其他工具结合来实现这一目标。

以上内容来源于互联网,不代表本站全部观点。 欢迎关注:zhujipindao.com

未经允许不得转载:主机频道 » 我可以使用 Python setup.py 生成文档吗?

评论 抢沙发

评论前必须登录!