Skip to content

Commit

Permalink
btrfs-progs: docs: add config file for readthedocs.io
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
kdave committed Dec 5, 2023
1 parent cc2e3ab commit 8b9684f
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
.*
!.editorconfig
!.github
!.readthedocs.yaml

/ci/images/*/devel.tar.gz

Expand Down
10 changes: 10 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions Documentation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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' ]
1 change: 1 addition & 0 deletions Documentation/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx_rtd_theme

0 comments on commit 8b9684f

Please sign in to comment.