notmuch/doc/mkdocdeps.py

import sys

srcdir = sys.argv[1]
builddir = sys.argv[2]
outfile = sys.argv[3]

sys.path.insert(0, srcdir)
import conf

roff_files = []
rst_files = []
for page in conf.man_pages:
    rst_files = rst_files + ["{0:s}/{1:s}.rst".format(srcdir,page[0])]
    roff_files = roff_files + ["{0:s}/man/{1:s}.{2:d}".format(builddir,page[0],page[4])]

with open(outfile, 'w') as out:
    out.write('MAN_ROFF_FILES := ' + ' \\\n\t'.join(roff_files) + '\n')
    out.write('MAN_RST_FILES := ' + ' \\\n\t'.join(rst_files) + '\n')
doc/mkdocdeps.py: Convert execfile to import excefile is gone in Python 3 [1]. Instead of exec-ing the configuration, it's easier to insert the source directory in Python's path [2], and just import the configuration. With this change, mkdocdeps.py is compatible with both Python 2 and 3. [1]: https://docs.python.org/3.0/whatsnew/3.0.html#builtins [2]: https://docs.python.org/3/library/sys.html#sys.path 2014-04-05 19:31:05 +02:00			`import sys`
doc: install sphinx version of man pages The python script mkdocdeps.py is used to import the list of man pages from the sphinx configuration to make. This will delete the (release only) target update-man-versions. This will be replaced in a followup commit. 2014-03-05 14:34:10 +01:00
doc/mkdocdeps.py: Convert execfile to import excefile is gone in Python 3 [1]. Instead of exec-ing the configuration, it's easier to insert the source directory in Python's path [2], and just import the configuration. With this change, mkdocdeps.py is compatible with both Python 2 and 3. [1]: https://docs.python.org/3.0/whatsnew/3.0.html#builtins [2]: https://docs.python.org/3/library/sys.html#sys.path 2014-04-05 19:31:05 +02:00			`srcdir = sys.argv[1]`
			`builddir = sys.argv[2]`
			`outfile = sys.argv[3]`
doc: fix out-of-tree build The subtle part is adding .rst and .py files to vpath so they can be used as dependencies without prefixing with $(srcdir) We also change the interface to mkbuildeps.py: rather than getting the containing directory from the conf file path, we go the other way. 2014-03-20 01:48:03 +01:00
doc/mkdocdeps.py: Convert execfile to import excefile is gone in Python 3 [1]. Instead of exec-ing the configuration, it's easier to insert the source directory in Python's path [2], and just import the configuration. With this change, mkdocdeps.py is compatible with both Python 2 and 3. [1]: https://docs.python.org/3.0/whatsnew/3.0.html#builtins [2]: https://docs.python.org/3/library/sys.html#sys.path 2014-04-05 19:31:05 +02:00			`sys.path.insert(0, srcdir)`
			`import conf`
doc: install sphinx version of man pages The python script mkdocdeps.py is used to import the list of man pages from the sphinx configuration to make. This will delete the (release only) target update-man-versions. This will be replaced in a followup commit. 2014-03-05 14:34:10 +01:00
			`roff_files = []`
doc: build man pages at build time; introduce HAVE_SPHINX, HAVE_RST2MAN This helps avoid build artifacts (namely, nroff and gzipped-nroff man pages) owned by root. The variables allow choosing which generator to use for the man page. These will be hooked to configure in a following commit. 2014-03-13 04:21:14 +01:00			`rst_files = []`
doc/mkdocdeps.py: Convert execfile to import excefile is gone in Python 3 [1]. Instead of exec-ing the configuration, it's easier to insert the source directory in Python's path [2], and just import the configuration. With this change, mkdocdeps.py is compatible with both Python 2 and 3. [1]: https://docs.python.org/3.0/whatsnew/3.0.html#builtins [2]: https://docs.python.org/3/library/sys.html#sys.path 2014-04-05 19:31:05 +02:00			`for page in conf.man_pages:`
doc: fix out-of-tree build The subtle part is adding .rst and .py files to vpath so they can be used as dependencies without prefixing with $(srcdir) We also change the interface to mkbuildeps.py: rather than getting the containing directory from the conf file path, we go the other way. 2014-03-20 01:48:03 +01:00			`rst_files = rst_files + ["{0:s}/{1:s}.rst".format(srcdir,page[0])]`
doc: build man pages into hierarchy, fix help test. It turns out there was a reason the old man pages were stored in a man compatible hierarchy, namely so that we could run man on them before installing. Hardcode doc build location into test suite. This isn't ideal, but let's unbreak the test suite for now. 2014-03-13 04:21:15 +01:00			`roff_files = roff_files + ["{0:s}/man/{1:s}.{2:d}".format(builddir,page[0],page[4])]`
doc: install sphinx version of man pages The python script mkdocdeps.py is used to import the list of man pages from the sphinx configuration to make. This will delete the (release only) target update-man-versions. This will be replaced in a followup commit. 2014-03-05 14:34:10 +01:00
doc/mkdocdeps.py: Use "with" statement for the output file Before this patch, the open was unnecessarily early and relied on the process cleanup to close. Neither one of these was a real problem, but PEP 343's context managers (which landed in Python 2.5) make proper cleanup very easy. [1]: http://legacy.python.org/dev/peps/pep-0343/ 2014-04-05 19:31:06 +02:00			`with open(outfile, 'w') as out:`
			`out.write('MAN_ROFF_FILES := ' + ' \\\n\t'.join(roff_files) + '\n')`
			`out.write('MAN_RST_FILES := ' + ' \\\n\t'.join(rst_files) + '\n')`