Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2025-02-10 09:19:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1614820 - Fixed normandy docs not re rendering.r=sylvestre,ahal

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D66911

--HG--
extra : moz-landing-system : lando
This commit is contained in:
Anurag Aggarwal 2020-03-20 20:21:07 +00:00
parent d4d9b8226c
commit dead557566
1 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
tools/moztreedocs/__init__.py
View File

@ -93,7 +93,7 @@ class _SphinxManager(object):
self.trees, self.python_package_dirs = read_build_config(app.srcdir)
logger.info('Staging static documentation')
self._synchronize_docs()
self._synchronize_docs(app)
logger.info('Generating Python API documentation')
self._generate_python_api_docs()
@ -146,7 +146,7 @@ class _SphinxManager(object):
# as it will be the the same file
m.add_link(markdown_file, dest)
def _synchronize_docs(self):
def _synchronize_docs(self, app):
m = InstallManifest()
with open(os.path.join(MAIN_DOC_PATH, 'config.yml'), 'r') as fh:
@ -195,16 +195,21 @@ class _SphinxManager(object):
for t in tree_config:
CATEGORIES[t] = format_paths(tree_config[t])
indexes = set([os.path.normpath(os.path.join(p, 'index')) for p in toplevel_trees.keys()])
# Format categories like indexes
cats = '\n'.join(CATEGORIES.values()).split("\n")
# Remove heading spaces
cats = [os.path.normpath(x.strip()) for x in cats]
indexes = tuple(set(indexes) - set(cats))
if indexes:
# In case a new doc isn't categorized
print(indexes)
raise Exception("Uncategorized documentation. Please add it in docs/config.yml")
# During livereload, we don't correctly rebuild the full document
# tree (Bug 1557020). The page is no longer referenced within the index
# tree, thus we shall check categorisation only if complete tree is being rebuilt.
if app.srcdir == self.topsrcdir:
indexes = set([os.path.normpath(os.path.join(p, 'index'))
for p in toplevel_trees.keys()])
# Format categories like indexes
cats = '\n'.join(CATEGORIES.values()).split("\n")
# Remove heading spaces
cats = [os.path.normpath(x.strip()) for x in cats]
indexes = tuple(set(indexes) - set(cats))
if indexes:
# In case a new doc isn't categorized
print(indexes)
raise Exception("Uncategorized documentation. Please add it in docs/config.yml")
data = data.format(**CATEGORIES)