.readthedocs.yaml

   1 # vim: ts=4 expandtab sw=4:
   2 #==================================================================================
   3 #       Copyright (c) 2019 Nokia
   4 #       Copyright (c) 2018-2019 AT&T Intellectual Property.
   5 #
   6 #   Licensed under the Apache License, Version 2.0 (the "License");
   7 #   you may not use this file except in compliance with the License.
   8 #   You may obtain a copy of the License at
   9 #
  10 #       http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 #   Unless required by applicable law or agreed to in writing, software
  13 #   distributed under the License is distributed on an "AS IS" BASIS,
  14 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 #   See the License for the specific language governing permissions and
  16 #   limitations under the License.
  17 #==================================================================================
  18
  19 # NOTE: this exists only to support the RTD scraper(s). Future: change requirements
  20 #               so this can be moved inside of docs/ rather than polluting the top level.
  21
  22 ---
  23 # .readthedocs.yml
  24 # Read the Docs configuration file
  25 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
  26 # Required
  27 version: 2
  28
  29 formats:
  30   - htmlzip
  31
  32 build:
  33   image: latest
  34
  35 python:
  36   version: 3.7
  37   install:
  38     - requirements: docs/requirements-docs.txt
  39
  40 sphinx:
  41   configuration: docs/conf.py
  42