瀏覽代碼

[DOCS] #4587 – Make Sphinx warnings break docs build

Prevent warnings of type "checking consistency... WARNING: document isn't included in any toctree" by using the :orphan: directive.
Thalian 5 年之前
父節點
當前提交
0359b97cce
共有 3 個文件被更改,包括 10 次插入0 次删除
  1. 6 0
      docs/book.rst
  2. 2 0
      docs/man_intro.rst
  3. 2 0
      docs/usage/borgfs.rst

+ 6 - 0
docs/book.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 .. include:: global.rst.inc
 .. include:: global.rst.inc
 
 
 Borg documentation
 Borg documentation
@@ -15,5 +17,9 @@ Borg documentation
     usage
     usage
     deployment
     deployment
     faq
     faq
+    support
+    resources
+    changes
     internals
     internals
     development
     development
+    authors

+ 2 - 0
docs/man_intro.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 SYNOPSIS
 SYNOPSIS
 --------
 --------
 
 

+ 2 - 0
docs/usage/borgfs.rst

@@ -1 +1,3 @@
+:orphan:
+
 .. include:: borgfs.rst.inc
 .. include:: borgfs.rst.inc