我可以使用conf.py在sphinx文档中显示版本历史记录表吗?

时间:2016-12-28 03:57:16

标签: python python-sphinx restructuredtext

我需要增加每个编辑的版本计数,并显示当前日期并以表格的形式显示。

1 个答案:

答案 0 :(得分:0)

没有sphinx固有方法可以自动增加版本号。但是由于conf.py是一个python文件,你可以实现一个包含在conf.py中的小函数,该函数从非易失性存储器(例如json文件)中读取版本,输出你的日期表并更新非增量版本号。 - 易失性存储器。也许是这样的(如果json内容是例如" [12,7,1,0]"):

# Read the version number from conf.json
fp = open( 'conf.json', 'r')
rev = json.load( fp ) # rev = [12,7,1,0]
fp.close

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#

# The short X.Y version.
version = '{}.{}'.format(rev[0], rev[1]) # version = "12.7"

# The full version, including alpha/beta/rc tags.
release = '{}.{}.{}.{}'.format(*rev) # release = "12.7.1.0"

# Write the incremented version number to conf.json
fp = open ( 'conf.json', 'w')
rev[0] += 1
json.dump( rev, fp )
fp.close()