1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2024-10-05 18:31:12 +01:00

docs: fix RTD build

- Bump python version used when building documentation.
- `setuptools` is a deprecated installation method on RTD so switch to `pip`.
- Add additional dependency on devlib master branch as RTD env is not
  respecting dependency_links during installation.
- Bump copyright year.
This commit is contained in:
Marc Bonnici 2023-05-05 16:12:28 -05:00
parent 13f9c64513
commit 775b24f7a3
3 changed files with 13 additions and 6 deletions

View File

@ -13,10 +13,16 @@ sphinx:
# Build the docs in additional formats such as PDF and ePub
formats: all
# Set the version of Python and requirements required to build your docs
# Configure the build environment
build:
os: ubuntu-22.04
tools:
python: "3.11"
# Ensure doc dependencies are installed before building
python:
version: 3.8
install:
- method: setuptools
path: .
- requirements: doc/requirements.txt
- method: pip
path: .

View File

@ -4,3 +4,4 @@ pandas
sphinx_rtd_theme==1.0.0
sphinx==4.2
docutils<0.18
devlib @ git+https://github.com/ARM-software/devlib@master

View File

@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
# Copyright 2018 ARM Limited
# Copyright 2023 ARM Limited
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
@ -68,7 +68,7 @@ master_doc = 'index'
# General information about the project.
project = u'wa'
copyright = u'2018, ARM Limited'
copyright = u'2023, ARM Limited'
author = u'ARM Limited'
# The version info for the project you're documenting, acts as replacement for