michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add missing doc top labels

Browse source 
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 <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2019-04-10 14:57:51 -07:00 • committed by Anas Nashif
commit 9d04f03bab
16 changed files with 38 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/404.rst
View file

@ -1,5 +1,7 @@
:orphan: :orphan:
.. _page-not-found:
Sorry, Page Not Found Sorry, Page Not Found
##################### #####################

2
doc/copyright.rst
View file

@ -1,5 +1,7 @@
:orphan: :orphan:
.. _doc-copyrights:
Documentation Copyrights Documentation Copyrights
######################## ########################

1
doc/development_process/code_flow.rst
View file

@ -1,3 +1,4 @@
.. _code-flow-and-branches:
Code Flow and Branches Code Flow and Branches
###################### ######################

22
doc/development_process/communication.rst
View file

@ -1,14 +1,16 @@
.. _communication-and-collaboration:
Communication and Collaboration Communication and Collaboration
################################ ################################
The `Zephyr project mailing lists <https://lists.zephyrproject.org/g/main/subgroups>`_ are used as the primary The `Zephyr project mailing lists
communication tool by project members, contributors, and the community. The <https://lists.zephyrproject.org/g/main/subgroups>`_ are used as the
mailing list is open for topics related to the project and should be used for primary communication tool by project members, contributors, and the
collaboration among team members working on the same feature or subsystem or for community. The mailing list is open for topics related to the project
discussing project direction and daily development of the code base. In general, and should be used for collaboration among team members working on the
bug reports and issues should be entered and tracked in the bug tracking system same feature or subsystem or for discussing project direction and daily
(`GitHub Issues <https://github.com/zephyrproject-rtos/zephyr/issues>`_) and not broadcasted to the mailing list, the same applies to development of the code base. In general, bug reports and issues should
code reviews. Code should be submitted to GitHub using the appropriate tools. be entered and tracked in the bug tracking system (`GitHub Issues
<https://github.com/zephyrproject-rtos/zephyr/issues>`_) and not
broadcasted to the mailing list, the same applies to code reviews. Code
should be submitted to GitHub using the appropriate tools.

2
doc/development_process/dev_env_and_tools.rst
View file

@ -1,4 +1,4 @@
.. _dev-environment-and-tools:
Development Environment and Tools Development Environment and Tools
################################# #################################

3
doc/development_process/documentation.rst
View file

@ -1,3 +1,4 @@
.. _code-documentation:
Code Documentation Code Documentation
################### ###################
@ -40,7 +41,7 @@ Test Code
********** **********
The Zephyr project uses several test methodologies, the most common being the The Zephyr project uses several test methodologies, the most common being the
:ref:`Ztest framework <testing>`. The documentation of tests should only be done :ref:`Ztest framework <test-framework>`. Test documentation should only be done
on the entry test functions (usually prefixed with test\_) and those that are 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 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 reports and using their name and identifier is the best way to identify them and

1
doc/development_process/proposals.rst
View file

@ -1,3 +1,4 @@
.. _feature-tracking:
Feature Tracking Feature Tracking
################# #################

2
doc/guides/bluetooth/gap-pics.rst
View file

@ -1,3 +1,5 @@
.. _gap-pics:
GAP PICS GAP PICS
******** ********

2
doc/guides/bluetooth/gatt-pics.rst
View file

@ -1,3 +1,5 @@
.. _gatt-pics:
GATT PICS GATT PICS
========= =========

2
doc/guides/bluetooth/l2cap-pics.rst
View file

@ -1,3 +1,5 @@
.. _l2cap-pics:
L2CAP PICS L2CAP PICS
========== ==========

2
doc/guides/bluetooth/rfcomm-pics.rst
View file

@ -1,3 +1,5 @@
.. _rfcomm-pics:
RFCOMM PICS RFCOMM PICS
*********** ***********

2
doc/guides/bluetooth/sm-pics.rst
View file

@ -1,3 +1,5 @@
.. _sm-pics:
SM PICS SM PICS
******* *******

2
doc/guides/test/index.rst
View file

@ -1,3 +1,5 @@
.. _testing:
Testing Testing
####### #######

2
doc/guides/test/ztest.rst
View file

@ -1,4 +1,4 @@
.. _testing: .. _test-framework:
Test Framework Test Framework
############### ###############

2
doc/guides/west/planned.rst
View file

@ -1,3 +1,5 @@
.. _west-planned-features:
Planned Features Planned Features
================ ================

2
doc/index.rst
View file

@ -1,6 +1,8 @@
.. ..
Zephyr Project documentation master file Zephyr Project documentation master file
.. _zephyr-home:
Zephyr Project Documentation Zephyr Project Documentation
############################ ############################