From bd1789261122c25d62b8e8e7f7d5647249e8d8ff Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Thu, 3 Dec 2020 22:38:34 +0100 Subject: sphinx: rename top level document in each manual It is more common to call the top level document index.rst. This is what this patch is doing, along with all required references fixup. (From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-common-tasks.rst | 6 +++--- documentation/dev-manual/dev-manual-intro.rst | 6 +++--- documentation/dev-manual/dev-manual-start.rst | 2 +- documentation/dev-manual/dev-manual.rst | 19 ------------------- documentation/dev-manual/index.rst | 19 +++++++++++++++++++ 5 files changed, 26 insertions(+), 26 deletions(-) delete mode 100644 documentation/dev-manual/dev-manual.rst create mode 100644 documentation/dev-manual/index.rst (limited to 'documentation/dev-manual') diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst index 891fd9b001..e22bcd50ec 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.rst +++ b/documentation/dev-manual/dev-manual-common-tasks.rst @@ -3644,7 +3644,7 @@ build host running Linux. - For information on how to build an image using :term:`Toaster`, see the - :doc:`../toaster-manual/toaster-manual`. + :doc:`../toaster-manual/index`. - For information on how to use ``devtool`` to build images, see the ":ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow`" @@ -3653,7 +3653,7 @@ build host running Linux. - For a quick example on how to build an image using the OpenEmbedded build system, see the - :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. + :doc:`../brief-yoctoprojectqs/index` document. The build process creates an entire Linux distribution from source and places it in your :term:`Build Directory` under @@ -3728,7 +3728,7 @@ The following figure and list overviews the build process: kernels built by the OpenEmbedded build system are placed in the Build Directory in ``tmp/deploy/images``. For information on how to run pre-built images such as ``qemux86`` and ``qemuarm``, see the - :doc:`../sdk-manual/sdk-manual` manual. For + :doc:`../sdk-manual/index` manual. For information about how to install these images, see the documentation for your particular board or machine. diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst index 9bbac9610c..94c481b7d8 100644 --- a/documentation/dev-manual/dev-manual-intro.rst +++ b/documentation/dev-manual/dev-manual-intro.rst @@ -31,13 +31,13 @@ This manual provides the following: This manual does not provide the following: - Redundant Step-by-step Instructions: For example, the - :doc:`../sdk-manual/sdk-manual` manual contains detailed + :doc:`../sdk-manual/index` manual contains detailed instructions on how to install an SDK, which is used to develop applications for target hardware. - Reference or Conceptual Material: This type of material resides in an appropriate reference manual. For example, system variables are - documented in the :doc:`../ref-manual/ref-manual`. + documented in the :doc:`../ref-manual/index`. - Detailed Public Information Not Specific to the Yocto Project: For example, exhaustive information on how to use the Source Control @@ -52,7 +52,7 @@ supplemental information is recommended for full comprehension. For introductory information on the Yocto Project, see the :yocto_home:`Yocto Project Website <>`. If you want to build an image with no knowledge of Yocto Project as a way of quickly testing it out, see the -:doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. +:doc:`../brief-yoctoprojectqs/index` document. For a comprehensive list of links and other documentation, see the ":ref:`ref-manual/resources:links and related documentation`" diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst index 1c2314c430..053f09cdcd 100644 --- a/documentation/dev-manual/dev-manual-start.rst +++ b/documentation/dev-manual/dev-manual-start.rst @@ -344,7 +344,7 @@ going to use BitBake, see the section. If you are going to use the Extensible SDK, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto Project Application Development and the Extensible Software Development -Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`../kernel-dev/kernel-dev`. If you are going to use +Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`../kernel-dev/index`. If you are going to use Toaster, see the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" section in the Toaster User Manual. diff --git a/documentation/dev-manual/dev-manual.rst b/documentation/dev-manual/dev-manual.rst deleted file mode 100644 index 8f09224fe8..0000000000 --- a/documentation/dev-manual/dev-manual.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -====================================== -Yocto Project Development Tasks Manual -====================================== - -| - -.. toctree:: - :caption: Table of Contents - :numbered: - - dev-manual-intro - dev-manual-start - dev-manual-common-tasks - dev-manual-qemu - history - -.. include:: /boilerplate.rst diff --git a/documentation/dev-manual/index.rst b/documentation/dev-manual/index.rst new file mode 100644 index 0000000000..8f09224fe8 --- /dev/null +++ b/documentation/dev-manual/index.rst @@ -0,0 +1,19 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +====================================== +Yocto Project Development Tasks Manual +====================================== + +| + +.. toctree:: + :caption: Table of Contents + :numbered: + + dev-manual-intro + dev-manual-start + dev-manual-common-tasks + dev-manual-qemu + history + +.. include:: /boilerplate.rst -- cgit v1.2.3-54-g00ecf