sphinx: fix internal links

Many of the internal links were not converted probably from DocBook
using pandoc. After looking at the various patterns, the follow series
of 'naive' Python regexp were used to perform some additional
automatic conversion.

Also, since we rely on built-in glossary, all links to terms need to
use the sphinx :term: syntax.

This commit is generated using the following Python series of regexp:

   line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__",
                 ":term:`\\1`",
                 line)

   line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__",
                 ":ref:`ref-tasks-\\1`",
                 line)

   line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
                 ":ref:`\\1.bbclass <ref-classes-\\1>`",
                 line)

   line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
                 ":ref:`\\1 <ref-classes-\\1>`",
                 line)

   line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__",
                 ":term:`Source Directory`",
                 line)

   line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__",
                 ":term:`Build Directory`",
                 line)

   line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__",
                 ":term:`Metadata`",
                 line)

   line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__",
                 ":term:`BitBake`",
                 line)

   line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__",
                 ":ref:`ref-manual/ref-images:Images`",
                 line)

   line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__",
                 ":ref:`ref-manual/ref-classes:Classes`",
                 line)

   line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__",
                 ":ref:`devtool-the-workspace-layer-structure`",
                 line)

   line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__",
                 ":term:`OpenEmbedded Build System`",
                 line)

   line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__",
                 ":term:`OpenEmbedded-Core (OE-Core)`",
                 line)

It won't catch multiline strings, but it catches a very large number
of occurences!

(From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 10 insertions, 10 deletions

diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index 3f845731a0..b27412cb25 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -260,7 +260,7 @@ accomplish this through a recipe that is a BitBake append
    Yocto Project Board Support Packages (BSP) Developer's Guide
    .
 
-The `Source Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__
+The :term:`Source Directory`
 contains both general layers and BSP layers right out of the box. You
 can easily identify layers that ship with a Yocto Project release in the
 Source Directory by their names. Layers typically have names that begin
@@ -461,7 +461,7 @@ Open-Embedded Build System Components
 -------------------------------------
 
 The following list consists of components associated with the
-`OpenEmbedded build system <&YOCTO_DOCS_REF_URL;#build-system-term>`__:
+:term:`OpenEmbedded Build System`:
 
 -  *BitBake:* BitBake is a core component of the Yocto Project and is
    used by the OpenEmbedded build system to build images. While BitBake
@@ -508,7 +508,7 @@ Reference Distribution (Poky)
 -----------------------------
 
 Poky is the Yocto Project reference distribution. It contains the
-`Open-Embedded build system <&YOCTO_DOCS_REF_URL;#build-system-term>`__
+:term:`OpenEmbedded Build System`
 (BitBake and OE-Core) as well as a set of metadata to get you started
 building your own distribution. See the
 `figure <#what-is-the-yocto-project>`__ in "What is the Yocto Project?"
@@ -618,7 +618,7 @@ Project.
 -  *Native Linux Host:* By far the best option for a Build Host. A
    system running Linux as its native operating system allows you to
    develop software by directly using the
-   `BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ tool. You can
+   :term:`BitBake` tool. You can
    accomplish all aspects of development from a familiar shell of a
    supported Linux distribution.
 
@@ -684,9 +684,9 @@ Reference Embedded Distribution (Poky)
 
 "Poky", which is pronounced *Pock*-ee, is the name of the Yocto
 Project's reference distribution or Reference OS Kit. Poky contains the
-`OpenEmbedded Build System <&YOCTO_DOCS_REF_URL;#build-system-term>`__
-(`BitBake <&YOCTO_DOCS_REF_URL;#bitbake-term>`__ and
-`OpenEmbedded-Core <&YOCTO_DOCS_REF_URL;#oe-core>`__) as well as a set
+:term:`OpenEmbedded Build System`
+(:term:`BitBake` and
+:term:`OpenEmbedded-Core (OE-Core)`) as well as a set
 of `metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ to get you started
 building your own distro. In other words, Poky is a base specification
 of the functionality needed for a typical embedded system as well as the
@@ -923,9 +923,9 @@ helpful for getting started:
    Another point worth noting is that historically within the Yocto
    Project, recipes were referred to as packages - thus, the existence
    of several BitBake variables that are seemingly mis-named, (e.g.
-   ```PR`` <&YOCTO_DOCS_REF_URL;#var-PR>`__,
-   ```PV`` <&YOCTO_DOCS_REF_URL;#var-PV>`__, and
-   ```PE`` <&YOCTO_DOCS_REF_URL;#var-PE>`__).
+   :term:`PR`,
+   :term:`PV`, and
+   :term:`PE`).
 
 -  *Poky:* Poky is a reference embedded distribution and a reference
    test configuration. Poky provides the following: