btrfs-progs: docs: add config file for readthedocs.io

kdave · kdave · commit 8b9684f9653d · 2023-12-05T16:36:24.000+01:00
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 <dsterba@suse.com>
diff --git 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
@@ -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
@@ -71,3 +71,5 @@
     ('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
@@ -0,0 +1 @@
+sphinx_rtd_theme

Original file line number	Diff line number	Diff line change
`@@ -71,3 +71,5 @@`
`71`	`71`	`('mkfs.btrfs', 'mkfs.btrfs', 'create a btrfs filesystem', '', 8),`
`72`	`72`	`('btrfs-man5', 'btrfs', 'topics about the BTRFS filesystem (mount options, supported file attributes and other)', '', 5),`
`73`	`73`	`]`
	`74`	`+`
	`75`	`+extensions = [ 'sphinx_rtd_theme' ]`