communication/.readthedocs.yaml at main · eclipse-score/communication · GitHub

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
63
64
65
66
67
68
69
70
71
72
# *******************************************************************************
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

# Read the Docs configuration file for Sphinx builds
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
#
# Project: SCORE Communication
# Recommended URL: https://score-communication.readthedocs.io/
# (Configure project slug in Read the Docs dashboard: Admin → Advanced Settings)
#
# This configuration installs Bazel and runs the full build pipeline on Read the Docs.
# Generated artifacts (Doxygen XML, API RST files, README) are created during the build.

# Required version 2 for all modern Read the Docs builds
version: 2

# Version control settings (optional - RTD will build all active versions by default)
# To control which branches/tags are built, configure in RTD dashboard: Admin → Versions
# URLs will be: /en/latest/, /en/stable/, /en/v1.0.0/, etc.

# Set the OS, Python version and other Bazel dependencies for the build environment
build:
  os: ubuntu-22.04
  tools:
    python: "3.12"
  apt_packages:
    - curl
    - gnupg
  jobs:
    pre_install:
      # Install Bazelisk (Bazel version manager) to local bin directory
      - mkdir -p $HOME/.local/bin
      - curl -Lo $HOME/.local/bin/bazel https://github.com/bazelbuild/bazelisk/releases/download/v1.19.0/bazelisk-linux-amd64
      - chmod +x $HOME/.local/bin/bazel
      # Use absolute path to bin as PATH does not persist across jobs
      - $HOME/.local/bin/bazel --version
    pre_build:
      # Run Bazel to generate documentation artifacts (Doxygen XML and API RST files)
      - $HOME/.local/bin/bazel build //docs/sphinx:generate_api_rst
      # Copy README.md to where Sphinx expects it
      - cp -f score/mw/com/README.md docs/sphinx/README.md
      # Copy generated RST files to where Sphinx expects them
      - mkdir -p docs/sphinx/generated
      - cp -f bazel-bin/docs/sphinx/generated/*.rst docs/sphinx/generated/
      # Copy Doxygen XML to the location where Breathe expects it
      - mkdir -p score/mw/com/design/doxygen_build/xml
      - cp -rf bazel-bin/score/mw/com/design/doxygen_build/xml/* score/mw/com/design/doxygen_build/xml/

# Sphinx builds the documentation using the artifacts generated by Bazel
sphinx:
  configuration: docs/sphinx/conf.py
  fail_on_warning: false

# Uncomment: Optionally build docs in additional formats such as PDF and ePub
# formats:
#   - pdf
#   - epub

# Python dependencies required to build docs
python:
  install:
    - requirements: requirements_lock.txt