mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
a91aa652e8
The in-tree Sphinx docs have been broken since bug 1041941 because processing moz.build files outside their context doesn't work. Specifically, templates aren't loaded (because this information usually comes from a parent moz.build file). A new execution mode is needed. I tried to implement a proper execution mode. However, I kept running into walls. While we should strive for a proper execution mode, this can be a follow-up, tracked in bug 1058359. This patch implements extraction of Sphinx variables from ast walking. It is extremely low-level and definitely a one-off. But it solves the problem at hand: |mach build-docs| will work after this patch is applied. --HG-- extra : rebase_source : abd0a91a3efb24d3adfa19f4cd281ce5fd6d0915 extra : amend_source : c1b4f79224bab55e65a8c2b0f3103475281416c1
61 lines
2.0 KiB
Python
61 lines
2.0 KiB
Python
# This Source Code Form is subject to the terms of the Mozilla Public
|
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
# file, # You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
from __future__ import unicode_literals
|
|
|
|
import os
|
|
|
|
from mach.decorators import (
|
|
CommandArgument,
|
|
CommandProvider,
|
|
Command,
|
|
)
|
|
|
|
from mozbuild.base import MachCommandBase
|
|
from mozbuild.frontend.reader import BuildReader
|
|
|
|
|
|
@CommandProvider
|
|
class Documentation(MachCommandBase):
|
|
"""Helps manage in-tree documentation."""
|
|
|
|
@Command('build-docs', category='build-dev',
|
|
description='Generate documentation for the tree.')
|
|
@CommandArgument('--format', default='html',
|
|
help='Documentation format to write.')
|
|
@CommandArgument('outdir', default='<DEFAULT>', nargs='?',
|
|
help='Where to write output.')
|
|
def build_docs(self, format=None, outdir=None):
|
|
self._activate_virtualenv()
|
|
self.virtualenv_manager.install_pip_package('mdn-sphinx-theme==0.4')
|
|
|
|
from moztreedocs import SphinxManager
|
|
|
|
if outdir == '<DEFAULT>':
|
|
outdir = os.path.join(self.topobjdir, 'docs')
|
|
|
|
manager = SphinxManager(self.topsrcdir, os.path.join(self.topsrcdir,
|
|
'tools', 'docs'), outdir)
|
|
|
|
# We don't care about GYP projects, so don't process them. This makes
|
|
# scanning faster and may even prevent an exception.
|
|
def remove_gyp_dirs(context):
|
|
context['GYP_DIRS'][:] = []
|
|
|
|
reader = BuildReader(self.config_environment,
|
|
sandbox_post_eval_cb=remove_gyp_dirs)
|
|
|
|
for path, name, key, value in reader.find_sphinx_variables():
|
|
reldir = os.path.dirname(path)
|
|
|
|
if name == 'SPHINX_TREES':
|
|
assert key
|
|
manager.add_tree(os.path.join(reldir, value),
|
|
os.path.join(reldir, key))
|
|
|
|
if name == 'SPHINX_PYTHON_PACKAGE_DIRS':
|
|
manager.add_python_package_dir(os.path.join(reldir, value))
|
|
|
|
return manager.generate_docs(format)
|