Add last-generated section to docs

This commit is contained in:
hugovk 2016-05-17 21:00:27 +03:00
parent 3b52320023
commit 68cb9733f9
4 changed files with 29 additions and 2 deletions

View File

@ -17,6 +17,10 @@ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU A copy of the license is included in the section entitled "GNU
Free Documentation License". Free Documentation License".
* Generated
This file last generated Tuesday, 17 May 2016 05:59PM UTC
* Glossary * Glossary
** ( ** (
*** (TM) *** (TM)

Binary file not shown.

View File

@ -15,6 +15,11 @@ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU A copy of the license is included in the section entitled "GNU
Free Documentation License". Free Documentation License".
</p>
<H2>Generated</H2>
<p>
This file last generated Tuesday, 17 May 2016 05:59PM UTC
</p> </p>
<H2>Glossary</H2> <H2>Glossary</H2>
<H3>(</H3> <H3>(</H3>

View File

@ -1,6 +1,7 @@
import os
import string
import operator import operator
import os
import datetime
import string
import time import time
def jargonParseEntry(filename): def jargonParseEntry(filename):
@ -75,6 +76,13 @@ def saveLicense(fp, year, publishername):
fp.write("A copy of the license is included in the section entitled \"GNU\n") fp.write("A copy of the license is included in the section entitled \"GNU\n")
fp.write("Free Documentation License\".\n\n") fp.write("Free Documentation License\".\n\n")
def saveGenerated(fp):
"""saves the last-generated timestamp"""
utcnow = datetime.datetime.utcnow().strftime("%A, %d %B %Y %I:%M%p UTC")
fp.write("This file last generated " + utcnow + "\n\n")
def jargonWithDefinitions(text, definitions, isHtml): def jargonWithDefinitions(text, definitions, isHtml):
result = '' result = ''
prevpos = 0 prevpos = 0
@ -114,6 +122,9 @@ def jargonToManpage(manpageFilename, entries, version, publishername):
fp.write(".SH LICENSE\n\n") fp.write(".SH LICENSE\n\n")
saveLicense(fp, year, publishername) saveLicense(fp, year, publishername)
fp.write(".SH GENERATED\n\n")
saveGenerated(fp)
for entry in entries: for entry in entries:
title = entry[0] title = entry[0]
text = entry[1] text = entry[1]
@ -152,6 +163,9 @@ def jargonToOrgMode(orgFilename, entries, version, publishername):
fp.write("* License\n\n") fp.write("* License\n\n")
saveLicense(fp, year, publishername) saveLicense(fp, year, publishername)
fp.write("* Generated\n\n")
saveGenerated(fp)
fp.write("* Glossary\n") fp.write("* Glossary\n")
subsection = '' subsection = ''
@ -193,6 +207,10 @@ def jargonToHTML(htmlFilename, entries, version, publishername):
fp.write(" <p>\n") fp.write(" <p>\n")
saveLicense(fp, year, publishername) saveLicense(fp, year, publishername)
fp.write(" </p>\n") fp.write(" </p>\n")
fp.write(" <H2>Generated</H2>\n")
fp.write(" <p>\n")
saveGenerated(fp)
fp.write(" </p>\n")
fp.write(" <H2>Glossary</H2>\n") fp.write(" <H2>Glossary</H2>\n")
subsection = '' subsection = ''