File: run_docs.py

package info (click to toggle)
python-pysnmp4 7.1.21-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 3,564 kB
  • sloc: python: 33,654; makefile: 166; javascript: 4
file content (62 lines) | stat: -rwxr-xr-x 1,928 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#!/usr/bin/env python3
"""
Script to build documentation for the project.
Uses sphinx-polyversion to generate multi-version docs.
"""

import argparse
import os
import subprocess
import sys
from pathlib import Path


def main():
    """Run documentation build using sphinx-polyversion."""
    # Parse command line arguments
    parser = argparse.ArgumentParser(
        description="Build documentation for this project."
    )
    parser.add_argument(
        "--verbose", action="store_true", help="Run with verbose output"
    )
    args = parser.parse_args()

    print("Building documentation with sphinx-polyversion...", file=sys.stderr)

    # Check if virtual environment is active
    if not Path(".venv").exists():
        print("No virtual environment found. Creating one...", file=sys.stderr)
        subprocess.run(["uv", "venv"], check=True)

        print("Installing dependencies...", file=sys.stderr)
        subprocess.run(["uv", "pip", "install", "-e", ".[dev]"], check=True)

    # Make sure uv and sphinx-polyversion are installed in the venv
    try:
        subprocess.run(["uv", "pip", "install", "uv"], check=True)
        subprocess.run(["uv", "pip", "install", "sphinx-polyversion"], check=True)
    except subprocess.CalledProcessError as e:
        print(f"Error installing dependencies: {e}", file=sys.stderr)
        sys.exit(1)

    # Build the command
    command = ["uv", "run", "sphinx-polyversion", "docs/poly.py"]

    if args.verbose:
        command.append("--verbose")

    # Display the command being run
    print(f"Executing: {' '.join(command)}", file=sys.stderr)

    # Run the command
    try:
        subprocess.run(command, check=True)
        print("Documentation built successfully!", file=sys.stderr)
    except subprocess.CalledProcessError as e:
        print(f"Error building documentation: {e}", file=sys.stderr)
        sys.exit(1)


if __name__ == "__main__":
    main()