From 8b9684f9653dfcfa3421068820027161e194c5a1 Mon Sep 17 00:00:00 2001 From: David Sterba Date: Tue, 5 Dec 2023 16:23:27 +0100 Subject: [PATCH] btrfs-progs: docs: add config file for readthedocs.io There's another config required for building the RTD documentation, https://docs.readthedocs.io/en/stable/config-file/ . [ci skip] Signed-off-by: David Sterba --- .gitignore | 1 + .readthedocs.yaml | 10 ++++++++++ Documentation/conf.py | 2 ++ Documentation/requirements.txt | 1 + 4 files changed, 14 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 Documentation/requirements.txt diff --git a/.gitignore b/.gitignore index edfaf250..26f1940d 100644 --- a/.gitignore +++ b/.gitignore @@ -73,6 +73,7 @@ .* !.editorconfig !.github +!.readthedocs.yaml /ci/images/*/devel.tar.gz diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..521e8c68 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,10 @@ +version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3.12" +sphinx: + configuration: Documentation/conf.py +python: + install: + - requirements: Documentation/requirements.txt diff --git a/Documentation/conf.py b/Documentation/conf.py index 1025e10d..0bff1bd0 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -71,3 +71,5 @@ man_pages = [ ('mkfs.btrfs', 'mkfs.btrfs', 'create a btrfs filesystem', '', 8), ('btrfs-man5', 'btrfs', 'topics about the BTRFS filesystem (mount options, supported file attributes and other)', '', 5), ] + +extensions = [ 'sphinx_rtd_theme' ] diff --git a/Documentation/requirements.txt b/Documentation/requirements.txt new file mode 100644 index 00000000..483a4e96 --- /dev/null +++ b/Documentation/requirements.txt @@ -0,0 +1 @@ +sphinx_rtd_theme