Skip to content

Commit

Permalink
docs: fix RTD build
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
marcbonnici committed Aug 21, 2023
1 parent 13f9c64 commit 8af052f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
14 changes: 10 additions & 4 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: .
1 change: 1 addition & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -68,7 +68,7 @@

# 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
Expand Down

0 comments on commit 8af052f

Please sign in to comment.