From 4d7f250159d71210eee3abaf3bd2f37d289c5844 Mon Sep 17 00:00:00 2001 From: Martin Robinson Date: Tue, 20 Jun 2023 12:37:54 +0200 Subject: Clean up rustdoc run 1. The options specified in `rustdoc-with-private` are essentially the default now so we can remove this script. 2. `./mach browse-doc` is redundant with `./mach doc --open` which uses the underlying cargo functionality to browse the documentation. Fixes #29888. --- python/servo/command_base.py | 10 +++------- python/servo/post_build_commands.py | 12 ++---------- 2 files changed, 5 insertions(+), 17 deletions(-) (limited to 'python') diff --git a/python/servo/command_base.py b/python/servo/command_base.py index 211691b6e62..2fe515dd19f 100644 --- a/python/servo/command_base.py +++ b/python/servo/command_base.py @@ -10,7 +10,7 @@ from __future__ import print_function import contextlib -from typing import Optional +from typing import List, Optional import distro import functools import gzip @@ -616,11 +616,7 @@ class CommandBase(object): if hosts_file_path: env['HOST_FILE'] = hosts_file_path - if not test_unit: - # This wrapper script is in bash and doesn't work on Windows - # where we want to run doctests as part of `./mach test-unit` - env['RUSTDOC'] = path.join(self.context.topdir, 'etc', 'rustdoc-with-private') - elif "msvc" in servo.platform.host_triple(): + if test_unit and "msvc" in servo.platform.host_triple(): # on MSVC, we need some DLLs in the path. They were copied # in to the servo.exe build dir, so just point PATH to that. util.prepend_paths_to_env(env, "PATH", path.dirname(self.get_binary_path(False, False))) @@ -824,7 +820,7 @@ class CommandBase(object): self.features += ["media-" + media_stack] def run_cargo_build_like_command( - self, command, cargo_args, + self, command: str, cargo_args: List[str], env=None, verbose=False, libsimpleservo=False, debug_mozjs=False, with_debug_assertions=False, diff --git a/python/servo/post_build_commands.py b/python/servo/post_build_commands.py index afe8b12dfd4..a5d76134c4f 100644 --- a/python/servo/post_build_commands.py +++ b/python/servo/post_build_commands.py @@ -14,6 +14,7 @@ import os import os.path as path import subprocess from shutil import copytree, rmtree, copy2 +from typing import List import servo.util @@ -242,7 +243,7 @@ class PostBuildCommands(CommandBase): 'params', nargs='...', help="Command-line arguments to be passed through to cargo doc") @CommandBase.build_like_command_arguments - def doc(self, params, **kwargs): + def doc(self, params: List[str], **kwargs): self.ensure_bootstrapped(rustup_components=["rust-docs"]) rustc_path = check_output( ["rustup" + BIN_SUFFIX, "which", "--toolchain", self.rust_toolchain(), "rustc"] @@ -278,12 +279,3 @@ class PostBuildCommands(CommandBase): static = path.join(self.context.topdir, "etc", "doc.servo.org") for name in os.listdir(static): copy2(path.join(static, name), path.join(docs, name)) - - @Command('browse-doc', - description='Generate documentation and open it in a web browser', - category='post-build') - def serve_docs(self): - self.doc([]) - import webbrowser - webbrowser.open("file://" + path.abspath(path.join( - servo.util.get_target_dir(), "doc", "servo", "index.html"))) -- cgit v1.2.3