From 060b1eb1e38b294495adab784da32ca4e9871d20 Mon Sep 17 00:00:00 2001 From: Ben Kaduk Date: Wed, 12 Dec 2012 13:23:03 -0500 Subject: Better names for doxygen-Sphinx bridge functions It is confusing when the codepath for the production doc build involves calling functions with names like "test". Rename things which are in active use so that routines which are actually only used for testing are more discernable as such. ticket: 7505 (new) tags: pullup target_version: 1.11 --- doc/tools/doxybuilder_funcs.py | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) (limited to 'doc/tools/doxybuilder_funcs.py') diff --git a/doc/tools/doxybuilder_funcs.py b/doc/tools/doxybuilder_funcs.py index c9b690185..bfcadfdf2 100644 --- a/doc/tools/doxybuilder_funcs.py +++ b/doc/tools/doxybuilder_funcs.py @@ -573,25 +573,22 @@ class DoxyFuncs(XML2AST): -class DoxyFuncsTest(DoxyFuncs): +class DoxyBuilderFuncs(DoxyFuncs): def __init__(self, xmlpath, rstpath): - super(DoxyFuncsTest,self).__init__(xmlpath) + super(DoxyBuilderFuncs,self).__init__(xmlpath) self.target_dir = rstpath outfile = '%s/%s' % (self.target_dir, 'out.txt') self.tmp = open(outfile, 'w') - def run_tests(self): - self.test_save() - - def test_run(self): - self.run() - - def test_save(self): + def run_all(self): self.run() templates = {'function': 'func_document.tmpl'} self.save(templates, self.target_dir) + def test_run(self): + self.run() + if __name__ == '__main__': - tester = DoxyFuncsTest(xmlpath, rstpath) - tester.run_tests() + builder = DoxyBuilderFuncs(xmlpath, rstpath) + builder.run_all() -- cgit