michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: remove warning "file not included in toctree"

Browse source 
Files that are included directly into other files are not referenced
in TOC trees. Quiet warning by tagging them :orphan:

Change-Id: I3a975420ce366ca155e8c0158dcd0fb7c094a4a0
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This commit is contained in:
Inaky Perez-Gonzalez 2016-06-13 12:53:57 -07:00 • committed by Anas Nashif
commit e3683c20ce
8 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/README.rst
View file

@ -1,3 +1,5 @@
:orphan:
Welcome to Zephyr Kernel Welcome to Zephyr Kernel
######################## ########################
@ -71,4 +73,4 @@ Review the available formats with:
If you want the LaTeX PDF output, you need to install all the Latex If you want the LaTeX PDF output, you need to install all the Latex
packages first. That installation is beyond the scope of this document. packages first. That installation is beyond the scope of this document.
.. _ReST documentation: http://sphinx-doc.org/rest.html .. _ReST documentation: http://sphinx-doc.org/rest.html

2
doc/about_zephyr.rst
View file

@ -1,3 +1,5 @@
:orphan:
.. _about_zephyr: .. _about_zephyr:
Introduction to the Zephyr Project Introduction to the Zephyr Project

2
doc/contribute/coding_style.rst
View file

@ -1,3 +1,5 @@
:orphan:
.. _coding_style: .. _coding_style:
Coding Style Coding Style

2
doc/contribute/error_code_conventions.rst
View file

@ -1,3 +1,5 @@
:orphan:
.. _error_code_conventions: .. _error_code_conventions:
Return Codes Return Codes

4
doc/contribute/maintainers.rst
View file

@ -1,3 +1,5 @@
:orphan:
.. _maintainers: .. _maintainers:
Information Regarding Maintainers Information Regarding Maintainers
@ -8,4 +10,4 @@ Read this information to learn how maintainers review changes using Gerrit.
Once a change is sent to Gerrit for review the maintainers Once a change is sent to Gerrit for review the maintainers
receive an email requesting them to review the change. The master receive an email requesting them to review the change. The master
branch should never be rebased. Code can be reverted as necessary, branch should never be rebased. Code can be reverted as necessary,
instead of rewriting the history. instead of rewriting the history.

2
doc/crypto/crypto.rst
View file

@ -1,3 +1,5 @@
:orphan:
Cryptography Cryptography
############ ############

2
doc/drivers/synchronous_call.rst
View file

@ -1,3 +1,5 @@
:orphan:
.. _synchronous_call: .. _synchronous_call:
Synchronous Calls Synchronous Calls

2
doc/substitutions.rst
View file

@ -1,3 +1,5 @@
:orphan:
.. |codename| replace:: Zephyr Kernel .. |codename| replace:: Zephyr Kernel
.. |project| replace:: Zephyr Project .. |project| replace:: Zephyr Project