From 980fa4284a10d511c89dfeec004676322e3b4e4e Mon Sep 17 00:00:00 2001 From: Kyle Conroy Date: Wed, 14 Jun 2023 07:42:37 -0700 Subject: [PATCH] docs: Add a ReadTheDocs config file --- .readthedocs.yaml | 22 ++++++++++++++++++++++ devenv.nix | 1 + 2 files changed, 23 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..9712e405d1 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/devenv.nix b/devenv.nix index 6063224607..f74b52c56b 100644 --- a/devenv.nix +++ b/devenv.nix @@ -7,5 +7,6 @@ pkgs.go pkgs.git pkgs.git-cliff + pkgs.python311 ]; }