Puis-je afficher une table d'historique des versions dans la documentation sphinx à l'aide de conf.py?

Question

Je dois incrémenter le nombre de versions avec chaque compilation et afficher la date actuelle et l'afficher sous la forme d'une table.

Answer 1

Il n'existe aucun moyen inhérent à sphinx pour incrémenter automatiquement le numéro de version. Mais comme conf.py est un fichier python, vous pouvez implémenter une petite fonction contenue dans conf.py qui lit la version à partir d'une mémoire non volatile (par exemple un fichier json), affiche votre table de date et met à jour le numéro de version incrémenté -mémoire volatile. Peut-être comme ceci (si le contenu de json est par exemple. "[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()