[all lang] add orphan option to avoid sphinx build warning

syjust · Sep 12, 2015 · dce8b38 · dce8b38
1 parent ecb1f3d
commit dce8b38
Show file tree

Hide file tree

Showing 18 changed files with 71 additions and 3 deletions.
diff --git a/en/contributing/documentation.rst b/en/contributing/documentation.rst
@@ -261,6 +261,16 @@ Cross Referencing Links
     The link's text would be the title that the link preceded. You can also
     provide custom link text using ``:ref:`Link text <label-name>```.
 
+Prevent Sphinx to Output Warnings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sphinx will output warnings if a file is not referenced in a toc-tree. It's
+a great way to ensure that all files have a link directed to them, but
+sometimes, you don't need to insert a link for a file, eg. for our
+`epub-contents` and `pdf-contents` files. In those cases, you can add
+``:orphan:`` at the top of the file, and the warnings will stop to alert you
+that the file is not in the toc-tree.
+
 Describing Classes and their Contents
 -------------------------------------
 

diff --git a/en/epub-contents.rst b/en/epub-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contents
 ########
 

diff --git a/en/pdf-contents.rst b/en/pdf-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contents
 ########
 

diff --git a/es/epub-contents.rst b/es/epub-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contents
 ########
 

diff --git a/es/pdf-contents.rst b/es/pdf-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contents
 ########
 

diff --git a/fr/contributing/documentation.rst b/fr/contributing/documentation.rst
@@ -273,6 +273,16 @@ Les liens croisés de référencement
     lien. Vous pouvez aussi fournir un texte de lien sur mesure en utilisant
     ``:ref:`Texte de lien <nom-label>```.
 
+Prevent Sphinx to Output Warnings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sphinx will output warnings if a file is not referenced in a toc-tree. It's
+a great way to ensure that all files have a link directed to them, but
+sometimes, you don't need to insert a link for a file, eg. for our
+`epub-contents` and `pdf-contents` files. In those cases, you can add
+``:orphan:`` at the top of the file, and the warnings will stop to alert you
+that the file is not in the toc-tree.
+
 Description des classes et de leur contenu
 ------------------------------------------
 

diff --git a/fr/epub-contents.rst b/fr/epub-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contenu
 #######
 

diff --git a/fr/pdf-contents.rst b/fr/pdf-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contenu
 #######
 

diff --git a/ja/contributing/documentation.rst b/ja/contributing/documentation.rst
@@ -163,6 +163,16 @@ ReST(Re Structured Text)はmarkdownやtextileと同様のプレーンテキス
     リンクのテキストはリンクの先にあるタイトルになります。
     また、 ``:ref:`リンクテキスト <ラベル名>``` として自由にリンクのテキストを指定することができます。
 
+Prevent Sphinx to Output Warnings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sphinx will output warnings if a file is not referenced in a toc-tree. It's
+a great way to ensure that all files have a link directed to them, but
+sometimes, you don't need to insert a link for a file, eg. for our
+`epub-contents` and `pdf-contents` files. In those cases, you can add
+``:orphan:`` at the top of the file, and the warnings will stop to alert you
+that the file is not in the toc-tree.
+
 クラスとその内容を記述する
 --------------------------
 

diff --git a/ja/epub-contents.rst b/ja/epub-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 コンテンツ
 ############
 

diff --git a/ja/pdf-contents.rst b/ja/pdf-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contents
 ########
 

diff --git a/pt/epub-contents.rst b/pt/epub-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Conteúdo
 ########
 

diff --git a/pt/pdf-contents.rst b/pt/pdf-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Conteúdo
 ########
 

diff --git a/tr/epub-contents.rst b/tr/epub-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contents
 ########
 

diff --git a/tr/pdf-contents.rst b/tr/pdf-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contents
 ########
 

diff --git a/zh/contributing/documentation.rst b/zh/contributing/documentation.rst
@@ -3,7 +3,7 @@
 
 给文档做贡献是很简单的。这些文件都托管在 https://github.com/cakephp/docs。请自行
 复制(*fork*)代码仓库，加入你的更改/改进/翻译，然后发出拉取请求来提交你的改动。你
-甚至可以在 GitHub 上在线地编辑文档，而完全不用下载文件--在任何页面上的"Improve 
+甚至可以在 GitHub 上在线地编辑文档，而完全不用下载文件--在任何页面上的"Improve
 this Doc"按键将会引导你进入该页面的 GitHub 在线编辑器。
 
 翻译
@@ -36,7 +36,7 @@ this Doc"按键将会引导你进入该页面的 GitHub 在线编辑器。
 
 这份新的 CakePHP 文档是以
 `ReST formatted text <http://en.wikipedia.org/wiki/ReStructuredText>`_ 格式写的。
-ReST (Re Structured Text)是与 markdown 或者 textile 类似的纯文本标记语法。在为 
+ReST (Re Structured Text)是与 markdown 或者 textile 类似的纯文本标记语法。在为
 CakePHP 的文档做出贡献时，为了保持一致性，建议你遵循下面的准则，来你格式化和组织
 你的文字。
 
@@ -168,10 +168,20 @@ CakePHP 的文档做出贡献时，为了保持一致性，建议你遵循下面
     在其他地方你可以用 ``:ref:`标签名称``` 引用上面的小节。链接的文字可以是标签之后的
     标题。你也可以使用 ``:ref:`链接文字 <标签名称>``` 的方式来提供自定义的链接文字。
 
+Prevent Sphinx to Output Warnings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sphinx will output warnings if a file is not referenced in a toc-tree. It's
+a great way to ensure that all files have a link directed to them, but
+sometimes, you don't need to insert a link for a file, eg. for our
+`epub-contents` and `pdf-contents` files. In those cases, you can add
+``:orphan:`` at the top of the file, and the warnings will stop to alert you
+that the file is not in the toc-tree.
+
 描述类和它们的内容
 ------------------
 
-CakePHP 文档使用 `phpdomain <http://pypi.python.org/pypi/sphinxcontrib-phpdomain>`_ 
+CakePHP 文档使用 `phpdomain <http://pypi.python.org/pypi/sphinxcontrib-phpdomain>`_
 提供自定义指令描述 PHP 对象和结构。我们必须使用这些指令和角色，才能保证正确的索引
 和交叉引用。
 

diff --git a/zh/epub-contents.rst b/zh/epub-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contents
 ########
 

diff --git a/zh/pdf-contents.rst b/zh/pdf-contents.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Contents
 ########
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    :orphan:
     Contenu
     #######
@@ Expand Down @@