diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-24 16:27:54 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:33 +0100 |
commit | c473fa229239752367c5d573160fc8738cf1907e (patch) | |
tree | f8520ba3aa3cf911333dbd31e38e9a52203a0285 /documentation/ref-manual/resources.rst | |
parent | 4cd953989de42c7a83f666c23e077d53b016a1f1 (diff) | |
download | poky-c473fa229239752367c5d573160fc8738cf1907e.tar.gz |
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>
Diffstat (limited to 'documentation/ref-manual/resources.rst')
-rw-r--r-- | documentation/ref-manual/resources.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 0a8811d95d..50f2afae03 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
@@ -79,7 +79,7 @@ instructions: | |||
79 | mailing list about OpenEmbedded. | 79 | mailing list about OpenEmbedded. |
80 | 80 | ||
81 | - ` <&OE_LISTS_URL;/listinfo/bitbake-devel>`__ - Discussion mailing | 81 | - ` <&OE_LISTS_URL;/listinfo/bitbake-devel>`__ - Discussion mailing |
82 | list about the `BitBake <#bitbake-term>`__ build tool. | 82 | list about the :term:`BitBake` build tool. |
83 | 83 | ||
84 | - ` <&YOCTO_LISTS_URL;/listinfo/poky>`__ - Discussion mailing list | 84 | - ` <&YOCTO_LISTS_URL;/listinfo/poky>`__ - Discussion mailing list |
85 | about `Poky <#poky>`__. | 85 | about `Poky <#poky>`__. |
@@ -179,7 +179,7 @@ Here is a list of resources you might find helpful: | |||
179 | - `Toaster User Manual <&YOCTO_DOCS_TOAST_URL;>`__\ *:* This manual | 179 | - `Toaster User Manual <&YOCTO_DOCS_TOAST_URL;>`__\ *:* This manual |
180 | introduces and describes how to set up and use Toaster. Toaster is an | 180 | introduces and describes how to set up and use Toaster. Toaster is an |
181 | Application Programming Interface (API) and web-based interface to | 181 | Application Programming Interface (API) and web-based interface to |
182 | the `OpenEmbedded Build System <#build-system-term>`__, which uses | 182 | the :term:`OpenEmbedded Build System`, which uses |
183 | BitBake, that reports build information. | 183 | BitBake, that reports build information. |
184 | 184 | ||
185 | - `FAQ <&YOCTO_WIKI_URL;/wiki/FAQ>`__\ *:* A list of commonly asked | 185 | - `FAQ <&YOCTO_WIKI_URL;/wiki/FAQ>`__\ *:* A list of commonly asked |