qiskit-documentation/start

#!/usr/bin/env python3
# This code is a Qiskit project.
#
# (C) Copyright IBM 2023.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.

import subprocess
import sys
from pathlib import Path

PWD = Path(__file__).parent
IMAGE = "icr.io/qc-open-source-docs-public/preview:latest"


def skip_apis() -> tuple[str]:
    """Mounts an empty directory to /docs/api/ to effectively exclude it"""
    if "--apis" in sys.argv:
        return ()
    print("Skipping API docs for speed; use --apis to include them")
    return ("-v", "/home/node/app/docs/api")

def main() -> None:
    print(
        "Warning: this may be using an outdated version of the app. Run "
        + f"`docker pull {IMAGE}` to check for updates.",
        file=sys.stderr,
    )
    # Keep this aligned with the Dockerfile at the root of the repository.
    cmd = [
        "docker",
        "run",
        "-v",
        f"{PWD}/docs:/home/node/app/docs",
        *skip_apis(),
        "-v",
        f"{PWD}/public:/home/node/app/packages/preview/public",
        "-p",
        "3000:3000",
        # Needed for ctrl-c to shut down the container.
        "--init",
        "--rm",
        IMAGE,
    ]
    subprocess.run(cmd, check=True)


if __name__ == "__main__":
    try:
        main()
    except KeyboardInterrupt:
        pass