Skip to content

Commit

Permalink
doc: remove warning "file not included in toctree"
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
inaky-intc authored and Anas Nashif committed Jun 14, 2016
1 parent 4bcb874 commit e3683c2
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 2 deletions.
4 changes: 3 additions & 1 deletion doc/README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Welcome to Zephyr Kernel
########################

Expand Down Expand Up @@ -71,4 +73,4 @@ Review the available formats with:
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.

.. _ReST documentation: http://sphinx-doc.org/rest.html
.. _ReST documentation: http://sphinx-doc.org/rest.html
2 changes: 2 additions & 0 deletions doc/about_zephyr.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _about_zephyr:

Introduction to the Zephyr Project
Expand Down
2 changes: 2 additions & 0 deletions doc/contribute/coding_style.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _coding_style:

Coding Style
Expand Down
2 changes: 2 additions & 0 deletions doc/contribute/error_code_conventions.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _error_code_conventions:

Return Codes
Expand Down
4 changes: 3 additions & 1 deletion doc/contribute/maintainers.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _maintainers:

Information Regarding Maintainers
Expand All @@ -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
receive an email requesting them to review the change. The master
branch should never be rebased. Code can be reverted as necessary,
instead of rewriting the history.
instead of rewriting the history.
2 changes: 2 additions & 0 deletions doc/crypto/crypto.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

Cryptography
############

Expand Down
2 changes: 2 additions & 0 deletions doc/drivers/synchronous_call.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _synchronous_call:

Synchronous Calls
Expand Down
2 changes: 2 additions & 0 deletions doc/substitutions.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. |codename| replace:: Zephyr Kernel

.. |project| replace:: Zephyr Project

0 comments on commit e3683c2

Please sign in to comment.