mirror of
https://github.com/kdave/btrfs-progs
synced 2024-12-18 12:25:12 +00:00
53 lines
2.3 KiB
Python
53 lines
2.3 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
project = 'BTRFS'
|
|
# TODO: get from date
|
|
copyright = '2021'
|
|
|
|
# TODO: copy from ../VERSION
|
|
release = '5.14.2'
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ['_build']
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ['_static']
|
|
|
|
man_pages = [
|
|
('btrfs-select-super', 'btrfs-select-super', 'overwrite primary superblock with a backup copy', '', '8'),
|
|
('btrfstune', 'btrfstune', 'tune various filesystem parameters', '', 8),
|
|
('fsck.btrfs', 'fsck.btrfs', 'do nothing, successfully', '', 8),
|
|
('btrfs-send', 'btrfs-send', 'generate a stream of changes between two subvolume snapshots', '', 8),
|
|
('btrfs-scrub', 'btrfs-scrub', 'scrub btrfs filesystem, verify block checksums', '', 8),
|
|
('btrfs-restore', 'btrfs-restore', 'try to restore files from a damaged filesystem image', '', 8),
|
|
('btrfs-rescue', 'btrfs-rescue', 'recover a damaged btrfs filesystem', '', 8),
|
|
('btrfs-replace', 'btrfs-replace', 'replace devices managed by btrfs with other device', '', 8),
|
|
('btrfs-receive', 'btrfs-receive', 'receive subvolumes from send stream', '', 8),
|
|
]
|