summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-24 16:27:54 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:33 +0100
commitc473fa229239752367c5d573160fc8738cf1907e (patch)
treef8520ba3aa3cf911333dbd31e38e9a52203a0285 /documentation/toaster-manual
parent4cd953989de42c7a83f666c23e077d53b016a1f1 (diff)
downloadpoky-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/toaster-manual')
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.rst2
-rw-r--r--documentation/toaster-manual/toaster-manual-setup-and-use.rst4
2 files changed, 3 insertions, 3 deletions
diff --git a/documentation/toaster-manual/toaster-manual-reference.rst b/documentation/toaster-manual/toaster-manual-reference.rst
index 47d08a157e..c98a27eeb8 100644
--- a/documentation/toaster-manual/toaster-manual-reference.rst
+++ b/documentation/toaster-manual/toaster-manual-reference.rst
@@ -244,7 +244,7 @@ Defining the Default Distro and Other Values
244This section defines the default distro value for new projects. By 244This section defines the default distro value for new projects. By
245default, it reserves the first Toaster Setting record "1". The following 245default, it reserves the first Toaster Setting record "1". The following
246demonstrates how to set the project default value for 246demonstrates how to set the project default value for
247```DISTRO`` <&YOCTO_DOCS_REF_URL;#var-DISTRO>`__: <!-- Set the project 247:term:`DISTRO`: <!-- Set the project
248default value for DISTRO --> <object model="orm.toastersetting" pk="1"> 248default value for DISTRO --> <object model="orm.toastersetting" pk="1">
249<field type="CharField" name="name">DEFCONF_DISTRO</field> <field 249<field type="CharField" name="name">DEFCONF_DISTRO</field> <field
250type="CharField" name="value">poky</field> </object> You can override 250type="CharField" name="value">poky</field> </object> You can override
diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.rst b/documentation/toaster-manual/toaster-manual-setup-and-use.rst
index d621e241e9..7e715403d0 100644
--- a/documentation/toaster-manual/toaster-manual-setup-and-use.rst
+++ b/documentation/toaster-manual/toaster-manual-setup-and-use.rst
@@ -132,7 +132,7 @@ superuser by following these steps:
132 command: $ export PATH=$PATH:$HOME/.local/bin 132 command: $ export PATH=$PATH:$HOME/.local/bin
133 133
1342. From the directory containing the Toaster database, which by default 1342. From the directory containing the Toaster database, which by default
135 is the `Build Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__, 135 is the :term:`Build Directory`,
136 invoke the ``createsuperuser`` command from ``manage.py``: $ cd 136 invoke the ``createsuperuser`` command from ``manage.py``: $ cd
137 ~/poky/build $ ../bitbake/lib/toaster/manage.py createsuperuser 137 ~/poky/build $ ../bitbake/lib/toaster/manage.py createsuperuser
138 138
@@ -482,7 +482,7 @@ For the ``bash`` case, version 4.3.30-r0 is built by default.
482Unfortunately, Toaster as it exists, is not able to override the default 482Unfortunately, Toaster as it exists, is not able to override the default
483recipe version. If you would like to build bash 3.2.48, you need to set 483recipe version. If you would like to build bash 3.2.48, you need to set
484the 484the
485```PREFERRED_VERSION`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_VERSION>`__ 485:term:`PREFERRED_VERSION`
486variable. You can do so from Toaster, using the "Add variable" form, 486variable. You can do so from Toaster, using the "Add variable" form,
487which is available in the "BitBake variables" page of the project 487which is available in the "BitBake variables" page of the project
488configuration section as shown in the following screen: 488configuration section as shown in the following screen: