.readthedocs.yaml

# .readthedocs.yaml -- Build configuration for MPS manual on Read The Docs
#
# Copyright (c) 2023 Ravenbrook Limited. See end of file for license.
#
# This file controls how Read the Docs builds and publishes the MPS
# manual at <https://memory-pool-system.readthedocs.io/>.
#
# See <https://docs.readthedocs.io/en/stable/config-file/v2.html> for
# the file format.
#
# Project configuration is at
# <https://readthedocs.org/projects/memory-pool-system/>.  The GitHub
# Ravenbot user <sysadmins@ravenbrook.com> is an administrator
# <https://readthedocs.org/profiles/Ravenbot/>.

version: 2

build:
  os: ubuntu-22.04
  tools:
    python: '3'

python:
  install:
    - requirements: manual/requirements.pip

sphinx:
  configuration: manual/source/conf.py
  fail_on_warning: true

# A. REFERENCES
#
# [Readthedocs] "Read the Docs: Documentation Simplified";
# <https://docs.readthedocs.io/en/stable/>.
#
#
# B. DOCUMENT HISTORY
#
# 2023-02-02 RB Created as part of MPS GitHub migration.
#
#
# C. COPYRIGHT AND LICENSE
#
# Copyright © 2023 Ravenbrook Limited <https://www.ravenbrook.com/>.
# 
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
# 
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#
# $Id$