docs: avoid orphan warnings for man-page skeletons

Use the `:orphan:` special metadata field [0] to tell Sphinx that this file is expected to not be included in any TOC-tree. [0]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#special-metadata-fields Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-08 08:08:03 +01:00 · 2024-03-08 08:08:03 +01:00 · ffc62ac94d
commit ffc62ac94d
parent f45784a567
21 changed files with 42 additions and 0 deletions
--- a/docs/config/acl/man5.rst
+++ b/docs/config/acl/man5.rst
@ -1,3 +1,5 @@
+:orphan:
+
 =======
 acl.cfg
 =======
--- a/docs/config/datastore/man5.rst
+++ b/docs/config/datastore/man5.rst
@ -1,3 +1,5 @@
+:orphan:
+
 =============
 datastore.cfg
 =============
--- a/docs/config/domains/man5.rst
+++ b/docs/config/domains/man5.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ===========
 domains.cfg
 ===========
--- a/docs/config/media-pool/man5.rst
+++ b/docs/config/media-pool/man5.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ==========================
 media-pool.cfg
 ==========================
--- a/docs/config/remote/man5.rst
+++ b/docs/config/remote/man5.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ==========
 remote.cfg
 ==========
--- a/docs/config/sync/man5.rst
+++ b/docs/config/sync/man5.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ========
 sync.cfg
 ========
--- a/docs/config/tape-job/man5.rst
+++ b/docs/config/tape-job/man5.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ============
 tape-job.cfg
 ============
--- a/docs/config/tape/man5.rst
+++ b/docs/config/tape/man5.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ========
 tape.cfg
 ========
--- a/docs/config/user/man5.rst
+++ b/docs/config/user/man5.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ========
 user.cfg
 ========
--- a/docs/config/verification/man5.rst
+++ b/docs/config/verification/man5.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ================
 verification.cfg
 ================
--- a/docs/pbs2to3/man1.rst
+++ b/docs/pbs2to3/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+

 =======
 pbs2to3
--- a/docs/pmt/man1.rst
+++ b/docs/pmt/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ===
 pmt
 ===
--- a/docs/pmtx/man1.rst
+++ b/docs/pmtx/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ==========================
 pmtx
 ==========================
--- a/docs/proxmox-backup-client/man1.rst
+++ b/docs/proxmox-backup-client/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+
 =====================
 proxmox-backup-client
 =====================
--- a/docs/proxmox-backup-debug/man1.rst
+++ b/docs/proxmox-backup-debug/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ====================
 proxmox-backup-debug
 ====================
--- a/docs/proxmox-backup-manager/man1.rst
+++ b/docs/proxmox-backup-manager/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ==========================
 proxmox-backup-manager
 ==========================
--- a/docs/proxmox-backup-proxy/man1.rst
+++ b/docs/proxmox-backup-proxy/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ==========================
 proxmox-backup-proxy
 ==========================
--- a/docs/proxmox-backup/man1.rst
+++ b/docs/proxmox-backup/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ==========================
 proxmox-backup
 ==========================
--- a/docs/proxmox-file-restore/man1.rst
+++ b/docs/proxmox-file-restore/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ====================
 proxmox-file-restore
 ====================
--- a/docs/proxmox-tape/man1.rst
+++ b/docs/proxmox-tape/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ============
 proxmox-tape
 ============
--- a/docs/pxar/man1.rst
+++ b/docs/pxar/man1.rst
@ -1,3 +1,5 @@
+:orphan:
+
 ====
 pxar
 ====