From 13e04ab929895cd615cc6c2c23edf0a6784afd1e Mon Sep 17 00:00:00 2001 From: Andrew E Slaughter Date: Tue, 27 Nov 2018 10:02:10 -0700 Subject: [PATCH] Updates for application support (refs #12528) --- python/MooseDocs/base/renderers.py | 4 ++-- python/MooseDocs/commands/build.py | 2 -- python/MooseDocs/extensions/appsyntax.py | 3 ++- python/MooseDocs/extensions/content.py | 26 +++++++++++++---------- python/MooseDocs/extensions/navigation.py | 2 +- python/MooseDocs/extensions/panoptic.py | 5 +++-- python/MooseDocs/main.py | 4 +--- 7 files changed, 24 insertions(+), 22 deletions(-) diff --git a/python/MooseDocs/base/renderers.py b/python/MooseDocs/base/renderers.py index e380c79cbe0d..0895a40e860d 100644 --- a/python/MooseDocs/base/renderers.py +++ b/python/MooseDocs/base/renderers.py @@ -251,8 +251,8 @@ def defaultConfig(): def __init__(self, *args, **kwargs): HTMLRenderer.__init__(self, *args, **kwargs) - self.__navigation = None # Cache for navigation pages - self.__index = False # page index created + self.__navigation = None # cache for navigation pages + self.__index = False # page index created self.addCSS('materialize', "contrib/materialize/materialize.min.css", media="screen,projection") diff --git a/python/MooseDocs/commands/build.py b/python/MooseDocs/commands/build.py index 7667791049d4..8a2d17be5313 100644 --- a/python/MooseDocs/commands/build.py +++ b/python/MooseDocs/commands/build.py @@ -99,7 +99,6 @@ def __init__(self, translator, options, *args, **kwargs): def build(self): """Build the necessary pages based on the current filepath.""" - print 'HERE:', self.filepath # Locate the page to be translated page = self._getPage(self.filepath) @@ -114,7 +113,6 @@ def build(self): if page.uid in uids: nodes.append(node) - print 'PAGE:', nodes self._translator.execute(self._options.num_threads, nodes) def _getPage(self, source): diff --git a/python/MooseDocs/extensions/appsyntax.py b/python/MooseDocs/extensions/appsyntax.py index e9745f868283..f9bfe36745d0 100644 --- a/python/MooseDocs/extensions/appsyntax.py +++ b/python/MooseDocs/extensions/appsyntax.py @@ -394,7 +394,7 @@ def createHeading(self, parent, page, **kwargs): if self.settings['heading'] == u'AUTO': h = ['Objects', 'Actions', 'Subsystems'] idx = [self.settings['objects'], self.settings['actions'], self.settings['subsystems']] - names = [h[i] for i in idx if i] + names = [h[i] for i, v in enumerate(idx) if v] if len(names) == 1: self.settings['heading'] = u'Available {}'.format(*names) elif len(names) == 2: @@ -434,6 +434,7 @@ def defaultSettings(): settings = SyntaxListCommand.defaultSettings() settings['group'] = (None, "The group (app) to limit the complete syntax list.") settings['level'] = (2, "Beginning heading level.") + settings['heading'] = (None, settings['heading'][1]) return settings def createTokenFromSyntax(self, parent, info, page, obj): diff --git a/python/MooseDocs/extensions/content.py b/python/MooseDocs/extensions/content.py index 0801bdcbd855..71e65a2e9bc3 100644 --- a/python/MooseDocs/extensions/content.py +++ b/python/MooseDocs/extensions/content.py @@ -50,24 +50,28 @@ def defaultSettings(): def createToken(self, parent, info, page): - location = self.settings['location'] tree = dict() tree[(u'',)] = core.UnorderedList(parent, browser_default=False) - func = lambda p: p.local.startswith(location) and isinstance(p, pages.Directory) - for node in self.translator.findPages(func): - key = tuple(node.local.strip(os.sep).replace(location, '').split(os.sep)) - if key not in tree: - col = Collapsible(tree[key[:-1]], summary=key[-1]) - li = core.ListItem(col, class_='moose-source-item', tooltip=False) - tree[key] = core.UnorderedList(li, browser_default=False) + + location = self.settings['location'] func = lambda p: p.local.startswith(location) and isinstance(p, pages.Source) - for node in self.translator.findPages(func): - dname = os.path.dirname(node.local).strip(os.sep) - key = tuple(dname.replace(location, '').split(os.sep)) + nodes = self.translator.findPages(func) + for node in nodes: + key = tuple(node.local.strip(os.sep).replace(location, '').split(os.sep))[:-1] + for i in xrange(1, len(key) + 1): + k = key[:i] + if k not in tree: + col = Collapsible(tree[k[:-1]], summary=k[-1]) + li = core.ListItem(col, class_='moose-source-item', tooltip=False) + tree[k] = core.UnorderedList(li, browser_default=False) + + for node in nodes: + key = tuple(node.local.strip(os.sep).replace(location, '').split(os.sep))[:-1] loc = node.relativeDestination(page) li = core.ListItem(tree[key]) core.Link(li, url=loc, string=node.name, class_='moose-source-item', tooltip=False) + return parent class AtoZCommand(command.CommandComponent): diff --git a/python/MooseDocs/extensions/navigation.py b/python/MooseDocs/extensions/navigation.py index c58030e83583..d849f9d1cb78 100644 --- a/python/MooseDocs/extensions/navigation.py +++ b/python/MooseDocs/extensions/navigation.py @@ -54,7 +54,7 @@ def extend(self, reader, renderer): self.requires(core, heading) menu = self.get('menu') - if (menu is None) and (renderer.get('navigation', None) is not None): + if (not menu) and (renderer.get('navigation', None) is not None): msg = "The navigation setting in the MaterializeRenderer is deprecated, " \ "please update your code to use the 'menu' setting within the " \ "MooseDocs.extensions.navigation extension." diff --git a/python/MooseDocs/extensions/panoptic.py b/python/MooseDocs/extensions/panoptic.py index 07bb93d29413..d6b907e5460a 100644 --- a/python/MooseDocs/extensions/panoptic.py +++ b/python/MooseDocs/extensions/panoptic.py @@ -7,8 +7,9 @@ #* #* Licensed under LGPL 2.1, please see LICENSE for details #* https://www.gnu.org/licenses/lgpl-2.1.html - +import logging from MooseDocs.extensions import common +LOG = logging.getLogger(__name__) def make_extension(**kwargs): - print "The panoptic extension has been renamed, use MooseDocs.extensions.common." + LOG.warning("The panoptic extension has been renamed, use MooseDocs.extensions.common.") return common.make_extension(**kwargs) diff --git a/python/MooseDocs/main.py b/python/MooseDocs/main.py index 9476f412a34b..f88bb4cdac49 100755 --- a/python/MooseDocs/main.py +++ b/python/MooseDocs/main.py @@ -60,9 +60,7 @@ def run(): warnings = log.MooseDocsFormatter.COUNTS['WARNING'].value print 'CRITICAL:{} ERROR:{} WARNING:{}'.format(critical, errors, warnings) - if critical or errors: - return 1 - elif errno != 0: + if critical or errors or (errno != 0): return 1 return 0