Gitiles
Code Review Sign In
gerrit.devboardsforandroid.linaro.org / website / 94ba492a59338ad4d0b7a47a34724aeaa6ac3db9 / . / .readthedocs.yaml
blob: 162e9fd6186c4f5e12ddc2c042789ce7667d833e [file] [log] [blame]
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]1# .readthedocs.yaml
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]2# Read the Docs configuration file
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]3# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]4# Required
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]5version: 2
6
7# Set the version of Python and other tools you might need
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]8build:
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]9 os: ubuntu-22.04
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]10 tools:
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]11 python: "3.10"
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]12 apt_packages:
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]13 - plantuml
14
15# Other variants to build than HTML
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]16formats: all
17
18# Build documentation in the docs/ directory with Sphinx
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]19sphinx:
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]20 configuration: docs/conf.py
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]21 fail_on_warning: true
22
23# Declare the Python requirements required to build your docs
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]24python:
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]25 install:
Sumit Semwal96df5d72023-07-17 16:16:40 +0530[diff] [blame]26 - requirements: docs/requirements.txt