From 9d04f03bab706668b08f970de5c334140f4e3f5f Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Wed, 10 Apr 2019 14:57:51 -0700 Subject: [PATCH] doc: add missing doc top labels All docs should have a label at the top that would permit cross-document linking via :ref:`labelname`. Update "testing" label that would have conflicted and fix the only reference to the old "testing" label in development process documentation. Signed-off-by: David B. Kinder --- doc/404.rst | 2 ++ doc/copyright.rst | 2 ++ doc/development_process/code_flow.rst | 1 + doc/development_process/communication.rst | 22 ++++++++++--------- doc/development_process/dev_env_and_tools.rst | 2 +- doc/development_process/documentation.rst | 3 ++- doc/development_process/proposals.rst | 1 + doc/guides/bluetooth/gap-pics.rst | 2 ++ doc/guides/bluetooth/gatt-pics.rst | 2 ++ doc/guides/bluetooth/l2cap-pics.rst | 2 ++ doc/guides/bluetooth/rfcomm-pics.rst | 2 ++ doc/guides/bluetooth/sm-pics.rst | 2 ++ doc/guides/test/index.rst | 2 ++ doc/guides/test/ztest.rst | 2 +- doc/guides/west/planned.rst | 2 ++ doc/index.rst | 2 ++ 16 files changed, 38 insertions(+), 13 deletions(-) diff --git a/doc/404.rst b/doc/404.rst index cd901cf43e7..2d35d8e67e1 100644 --- a/doc/404.rst +++ b/doc/404.rst @@ -1,5 +1,7 @@ :orphan: +.. _page-not-found: + Sorry, Page Not Found ##################### diff --git a/doc/copyright.rst b/doc/copyright.rst index af6edaf07b0..7b8dbfafa9b 100644 --- a/doc/copyright.rst +++ b/doc/copyright.rst @@ -1,5 +1,7 @@ :orphan: +.. _doc-copyrights: + Documentation Copyrights ######################## diff --git a/doc/development_process/code_flow.rst b/doc/development_process/code_flow.rst index b339f2add64..bcf5fb7783d 100644 --- a/doc/development_process/code_flow.rst +++ b/doc/development_process/code_flow.rst @@ -1,3 +1,4 @@ +.. _code-flow-and-branches: Code Flow and Branches ###################### diff --git a/doc/development_process/communication.rst b/doc/development_process/communication.rst index 29702a1adc7..64d03d93704 100644 --- a/doc/development_process/communication.rst +++ b/doc/development_process/communication.rst @@ -1,14 +1,16 @@ - +.. _communication-and-collaboration: Communication and Collaboration ################################ -The `Zephyr project mailing lists `_ are used as the primary -communication tool by project members, contributors, and the community. The -mailing list is open for topics related to the project and should be used for -collaboration among team members working on the same feature or subsystem or for -discussing project direction and daily development of the code base. In general, -bug reports and issues should be entered and tracked in the bug tracking system -(`GitHub Issues `_) and not broadcasted to the mailing list, the same applies to -code reviews. Code should be submitted to GitHub using the appropriate tools. - +The `Zephyr project mailing lists +`_ are used as the +primary communication tool by project members, contributors, and the +community. The mailing list is open for topics related to the project +and should be used for collaboration among team members working on the +same feature or subsystem or for discussing project direction and daily +development of the code base. In general, bug reports and issues should +be entered and tracked in the bug tracking system (`GitHub Issues +`_) and not +broadcasted to the mailing list, the same applies to code reviews. Code +should be submitted to GitHub using the appropriate tools. diff --git a/doc/development_process/dev_env_and_tools.rst b/doc/development_process/dev_env_and_tools.rst index c46965e0af0..41754a6ff44 100644 --- a/doc/development_process/dev_env_and_tools.rst +++ b/doc/development_process/dev_env_and_tools.rst @@ -1,4 +1,4 @@ - +.. _dev-environment-and-tools: Development Environment and Tools ################################# diff --git a/doc/development_process/documentation.rst b/doc/development_process/documentation.rst index 0ed644666f8..5b4488ff0a1 100644 --- a/doc/development_process/documentation.rst +++ b/doc/development_process/documentation.rst @@ -1,3 +1,4 @@ +.. _code-documentation: Code Documentation ################### @@ -40,7 +41,7 @@ Test Code ********** The Zephyr project uses several test methodologies, the most common being the -:ref:`Ztest framework `. The documentation of tests should only be done +:ref:`Ztest framework `. Test documentation should only be done on the entry test functions (usually prefixed with test\_) and those that are called directly by the Ztest framework. Those tests are going to appear in test reports and using their name and identifier is the best way to identify them and diff --git a/doc/development_process/proposals.rst b/doc/development_process/proposals.rst index 344e1080e8d..78450373fe0 100644 --- a/doc/development_process/proposals.rst +++ b/doc/development_process/proposals.rst @@ -1,3 +1,4 @@ +.. _feature-tracking: Feature Tracking ################# diff --git a/doc/guides/bluetooth/gap-pics.rst b/doc/guides/bluetooth/gap-pics.rst index bdc58976e72..8f074b10b7d 100644 --- a/doc/guides/bluetooth/gap-pics.rst +++ b/doc/guides/bluetooth/gap-pics.rst @@ -1,3 +1,5 @@ +.. _gap-pics: + GAP PICS ******** diff --git a/doc/guides/bluetooth/gatt-pics.rst b/doc/guides/bluetooth/gatt-pics.rst index 5e4d1d0ce45..c3469cc06f1 100644 --- a/doc/guides/bluetooth/gatt-pics.rst +++ b/doc/guides/bluetooth/gatt-pics.rst @@ -1,3 +1,5 @@ +.. _gatt-pics: + GATT PICS ========= diff --git a/doc/guides/bluetooth/l2cap-pics.rst b/doc/guides/bluetooth/l2cap-pics.rst index 6e406ca3289..88dbb6f49c1 100644 --- a/doc/guides/bluetooth/l2cap-pics.rst +++ b/doc/guides/bluetooth/l2cap-pics.rst @@ -1,3 +1,5 @@ +.. _l2cap-pics: + L2CAP PICS ========== diff --git a/doc/guides/bluetooth/rfcomm-pics.rst b/doc/guides/bluetooth/rfcomm-pics.rst index 0d61a2f8db7..56cdb6ecbf5 100644 --- a/doc/guides/bluetooth/rfcomm-pics.rst +++ b/doc/guides/bluetooth/rfcomm-pics.rst @@ -1,3 +1,5 @@ +.. _rfcomm-pics: + RFCOMM PICS *********** diff --git a/doc/guides/bluetooth/sm-pics.rst b/doc/guides/bluetooth/sm-pics.rst index e1bd8e18413..cceb1602ded 100644 --- a/doc/guides/bluetooth/sm-pics.rst +++ b/doc/guides/bluetooth/sm-pics.rst @@ -1,3 +1,5 @@ +.. _sm-pics: + SM PICS ******* diff --git a/doc/guides/test/index.rst b/doc/guides/test/index.rst index dc4540c7502..f401b71a216 100644 --- a/doc/guides/test/index.rst +++ b/doc/guides/test/index.rst @@ -1,3 +1,5 @@ +.. _testing: + Testing ####### diff --git a/doc/guides/test/ztest.rst b/doc/guides/test/ztest.rst index 1115400d4de..8eddd77130b 100644 --- a/doc/guides/test/ztest.rst +++ b/doc/guides/test/ztest.rst @@ -1,4 +1,4 @@ -.. _testing: +.. _test-framework: Test Framework ############### diff --git a/doc/guides/west/planned.rst b/doc/guides/west/planned.rst index 81582645ba5..11d5dcbbd27 100644 --- a/doc/guides/west/planned.rst +++ b/doc/guides/west/planned.rst @@ -1,3 +1,5 @@ +.. _west-planned-features: + Planned Features ================ diff --git a/doc/index.rst b/doc/index.rst index ccc817a824b..17e6e0b4a70 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,6 +1,8 @@ .. Zephyr Project documentation master file +.. _zephyr-home: + Zephyr Project Documentation ############################