diff --git a/docs/conf.py b/docs/conf.py
index 23744c0133..52f2e7e1e2 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -204,7 +204,25 @@ def static_relative(path):
def get_git_branch():
- """Get the git branch this repository is currently on."""
+ """Get the git branch this repository is currently on.
+
+ On Read the Docs the repo is checked out in detached-HEAD mode, so
+ ``git name-rev`` returns synthetic names like ``remotes/origin/external-1234``
+ instead of the real branch. A workaround is provided using
+ ``READTHEDOCS_VERSION_TYPE`` and ``READTHEDOCS_VERSION`` according to the build type:
+ - ``"branch"`` builds: READTHEDOCS_VERSION is the branch name (e.g. ``"3.6.x"``) → use it.
+ - ``"tag"`` builds: READTHEDOCS_VERSION is the tag name (e.g. ``"v3.6.0"``) → use it.
+ - ``"external"`` (PR preview) builds: READTHEDOCS_VERSION is the PR number (e.g. ``"1241"``)
+ which is not a valid git ref. In this case we return None so resolve_fallback_branch falls
+ back to its default instead of generating broken GitHub URLs.
+ - Local builds: READTHEDOCS_VERSION_TYPE is unset → fall back to git name-rev.
+ """
+ rtd_type = os.environ.get("READTHEDOCS_VERSION_TYPE")
+ if rtd_type in ("branch", "tag"):
+ return os.environ.get("READTHEDOCS_VERSION")
+ if rtd_type == "external":
+ return None
+
path_to_here = os.path.abspath(os.path.dirname(__file__))
# Invoke git to get the current branch which we use to get the theme
@@ -226,12 +244,28 @@ def get_git_branch():
return p.communicate()[0].decode().rstrip()
except Exception:
+ # Local build without git or some error occurred
print("Could not get the branch")
# Couldn't figure out the branch probably due to an error
return None
+def resolve_fallback_branch(env_var, docs_branch, default="master"):
+ """
+ Resolve the branch to use for GitHub links.
+
+ Priority:
+ 1. Environment variable ``env_var`` (e.g. FASTDDS_BRANCH)
+ 2. Current documentation branch (``docs_branch``)
+ 3. Hard-coded ``default``
+
+ This mirrors the checkout logic used in the ReadTheDocs clone block so
+ that extlinks and the actual checkout always point at the same branch.
+ """
+ return os.environ.get(env_var) or docs_branch or default
+
+
def configure_doxyfile(
doxyfile_in,
doxyfile_out,
@@ -279,6 +313,27 @@ def configure_doxyfile(
# Header files
input_dir = os.path.abspath("{}/fastdds/include/fastdds".format(project_binary_dir))
+# Current branch of the documentation repository — resolved once, used everywhere.
+docs_branch = get_git_branch()
+if docs_branch:
+ print('Current documentation branch is "{}"'.format(docs_branch))
+else:
+ print("Current documentation branch could not be determined; " \
+ "GitHub links will point to default branches instead of the corresponding branch.")
+
+# Resolve GitHub link branches: env var → current docs branch → default.
+# Computed here so they are available both in the ReadTheDocs clone block and in extlinks.
+fastdds_fallback_branch = resolve_fallback_branch("FASTDDS_BRANCH", docs_branch, "master")
+fastdds_docs_fallback_branch = resolve_fallback_branch("FASTDDS_DOCS_BRANCH", docs_branch, "master")
+fastdds_python_fallback_branch = resolve_fallback_branch("FASTDDS_PYTHON_BRANCH", docs_branch, "master")
+fastdds_gen_fallback_branch = resolve_fallback_branch("FASTDDS_GEN_BRANCH", docs_branch, "master")
+
+print("Fallback branches for GitHub links:")
+print(' Fast-DDS: "{}"'.format(fastdds_fallback_branch))
+print(' Fast-DDS-docs: "{}"'.format(fastdds_docs_fallback_branch))
+print(' Fast-DDS-Python: "{}"'.format(fastdds_python_fallback_branch))
+print(' Fast-DDS-Gen: "{}"'.format(fastdds_gen_fallback_branch))
+
# Check if we're running on Read the Docs' servers
read_the_docs_build = os.environ.get("READTHEDOCS", None) == "True"
if read_the_docs_build:
@@ -311,24 +366,14 @@ def configure_doxyfile(
fastdds_repo_name,
)
- # Documentation repository branch
- docs_branch = get_git_branch()
- print('Current documentation branch is "{}"'.format(docs_branch))
-
- # User specified Fast DDS branch
- fastdds_branch = os.environ.get("FASTDDS_BRANCH", None)
-
- # First try to checkout to ${FASTDDS_BRANCH}
- # Else try with current documentation branch
- # Else checkout to master
- if fastdds_branch and fastdds.refs.__contains__("origin/{}".format(fastdds_branch)):
+ # Verify the desired branch actually exists in the cloned remote, falling back to master if not.
+ fastdds_branch = fastdds_fallback_branch
+ if fastdds.refs.__contains__("origin/{}".format(fastdds_branch)):
fastdds_branch = "origin/{}".format(fastdds_branch)
- elif docs_branch and fastdds.refs.__contains__("origin/{}".format(docs_branch)):
- fastdds_branch = "origin/{}".format(docs_branch)
else:
print(
- 'Fast DDS does not have either "{}" or "{}" branches'.format(
- fastdds_branch, docs_branch
+ 'Fast DDS does not have branch "{}"; falling back to master'.format(
+ fastdds_branch
)
)
fastdds_branch = "origin/master"
@@ -344,24 +389,14 @@ def configure_doxyfile(
fastdds_python_repo_name,
)
- # User specified Fast DDS branch
- fastdds_python_branch = os.environ.get("FASTDDS_PYTHON_BRANCH", None)
-
- # First try to checkout to ${FASTDDS_PYTHON_BRANCH}
- # Else try with current documentation branch
- # Else checkout to master
- if fastdds_python_branch and fastdds_python.refs.__contains__(
- "origin/{}".format(fastdds_python_branch)
- ):
+ # Verify the desired branch actually exists in the cloned remote, falling back to master if not.
+ fastdds_python_branch = fastdds_python_fallback_branch
+ if fastdds_python.refs.__contains__("origin/{}".format(fastdds_python_branch)):
fastdds_python_branch = "origin/{}".format(fastdds_python_branch)
- elif docs_branch and fastdds_python.refs.__contains__(
- "origin/{}".format(docs_branch)
- ):
- fastdds_python_branch = "origin/{}".format(docs_branch)
else:
print(
- 'Fast DDS Python does not have either "{}" or "{}" branches'.format(
- fastdds_python_branch, docs_branch
+ 'Fast DDS Python does not have branch "{}"; falling back to master'.format(
+ fastdds_python_branch
)
)
fastdds_python_branch = "origin/main"
@@ -441,10 +476,34 @@ def configure_doxyfile(
"sphinx_copybutton",
"sphinx_design",
"sphinx.ext.autodoc", # Document Pydoc documentation from Python bindings.
+ "sphinx.ext.extlinks",
"sphinx_substitution_extensions",
"sphinx_toolbox.collapse",
]
+extlinks = {
+ # Fast-DDS repo (tree = directory, blob = file)
+ "fastdds-tree": (
+ f"https://github.com/eProsima/Fast-DDS/tree/{fastdds_fallback_branch}/%s", "%s"
+ ),
+ "fastdds-blob": (
+ f"https://github.com/eProsima/Fast-DDS/blob/{fastdds_fallback_branch}/%s", "%s"
+ ),
+ # Fast-DDS-python repo
+ "fastdds-python-tree": (
+ f"https://github.com/eProsima/Fast-DDS-Python/tree/{fastdds_python_fallback_branch}/%s", "%s"
+ ),
+ # Fast-DDS-docs repo (code examples embedded in the docs repo)
+ "fastdds-docs-tree": (
+ f"https://github.com/eProsima/Fast-DDS-docs/tree/{fastdds_docs_fallback_branch}/%s", "%s"
+ ),
+ # Fast-DDS-Gen raw files
+ "fastddsgen-raw": (
+ f"https://raw.githubusercontent.com/eProsima/Fast-DDS-Gen/{fastdds_gen_fallback_branch}/%s",
+ "%s",
+ ),
+}
+
sphinx_tabs_disable_css_loading = False
sphinx_tabs_disable_tab_closing = True
@@ -645,6 +704,10 @@ def configure_doxyfile(
Pro
.. |ProjectVersion| replace:: {version}
+
+.. |FastDDSBranch| replace:: {fastdds_fallback_branch}
+
+.. |FastDDSPythonBranch| replace:: {fastdds_python_fallback_branch}
"""
diff --git a/docs/fastdds/discovery/discovery_server.rst b/docs/fastdds/discovery/discovery_server.rst
index e669b7a9fa..28aa557c75 100644
--- a/docs/fastdds/discovery/discovery_server.rst
+++ b/docs/fastdds/discovery/discovery_server.rst
@@ -315,8 +315,9 @@ Full example
^^^^^^^^^^^^
The following constitutes a full example on how to configure *server* and *client* both programmatically and using XML.
-You may also have a look at the *eProsima Fast DDS* Github repository, which contains `an example `_
-similar to the one discussed in this section, as well as multiple other examples for different use cases.
+You may also have a look at the *eProsima Fast DDS* Github repository, which contains
+:fastdds-tree:`an example ` similar to the one discussed in this section, as well as
+multiple other examples for different use cases.
Server side setup
"""""""""""""""""
diff --git a/docs/fastdds/discovery/static.rst b/docs/fastdds/discovery/static.rst
index c17ffe2705..01bf7bae02 100644
--- a/docs/fastdds/discovery/static.rst
+++ b/docs/fastdds/discovery/static.rst
@@ -63,7 +63,7 @@ and DataReaders) must be statically specified, which is done using dedicated XML
A |DomainParticipant| may load several of such configuration files so that the information about different entities can
be contained in one file, or split into different files to keep it more organized.
*Fast DDS* provides a
-`Static Discovery example `_
+:fastdds-blob:`Static Discovery example `
that implements this EDP discovery protocol.
The following table describes all the possible elements of a STATIC EDP XML configuration file.
diff --git a/docs/fastdds/getting_started/simple_app/includes/sum_and_next_steps.rst b/docs/fastdds/getting_started/simple_app/includes/sum_and_next_steps.rst
index fbc8297e8e..17387aeb2e 100644
--- a/docs/fastdds/getting_started/simple_app/includes/sum_and_next_steps.rst
+++ b/docs/fastdds/getting_started/simple_app/includes/sum_and_next_steps.rst
@@ -10,4 +10,4 @@ Next steps
In the *eProsima Fast DDS* Github repository you will find more complex examples that implement DDS communication for
a multitude of use cases and scenarios. You can find them
-`here `_.
+:fastdds-tree:`here `.
diff --git a/docs/fastdds/getting_started/simple_python_app/includes/sum_and_next_steps.rst b/docs/fastdds/getting_started/simple_python_app/includes/sum_and_next_steps.rst
index 7b066b5358..2e84d3acfb 100644
--- a/docs/fastdds/getting_started/simple_python_app/includes/sum_and_next_steps.rst
+++ b/docs/fastdds/getting_started/simple_python_app/includes/sum_and_next_steps.rst
@@ -9,4 +9,4 @@ Next steps
In the *eProsima Fast DDS* Github repository you will find more complex examples that implement DDS communication for
a multitude of use cases and scenarios. You can find them
-`here `_.
+:fastdds-python-tree:`here `.
diff --git a/docs/fastdds/rtps_layer/rtps_layer.rst b/docs/fastdds/rtps_layer/rtps_layer.rst
index 4a5cd66df0..37040820f9 100644
--- a/docs/fastdds/rtps_layer/rtps_layer.rst
+++ b/docs/fastdds/rtps_layer/rtps_layer.rst
@@ -41,7 +41,7 @@ explaining the new features it presents.
We recommend you to look at the example describing how to use the RTPS layer that come with the distribution
while reading this section.
It is located in
-`examples/cpp/rtps `_.
+:fastdds-tree:`examples/cpp/rtps `.
Managing the Participant
^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/fastdds/security/access_control_plugin/access_control_plugin.rst b/docs/fastdds/security/access_control_plugin/access_control_plugin.rst
index b3566ba426..4fb0d4ccd8 100644
--- a/docs/fastdds/security/access_control_plugin/access_control_plugin.rst
+++ b/docs/fastdds/security/access_control_plugin/access_control_plugin.rst
@@ -105,9 +105,9 @@ The following is an example of the Domain Governance XML file contents.
:end-before: <-->
:linenos:
-The `Governance XSD file `_ and
+The :fastdds-blob:`Governance XSD file ` and
the
-`Governance XML example `_
+:fastdds-blob:`Governance XML example `
can also be downloaded from the `eProsima Fast DDS Github repository `_.
Domain Rules
@@ -442,9 +442,9 @@ The following is an example of the DomainParticipant Permissions XML file conten
:end-before: <-->
:linenos:
-The `Permissions XSD file `_ and
+The :fastdds-blob:`Permissions XSD file ` and
the
-`Permissions XML example `_
+:fastdds-blob:`Permissions XML example `
can also be downloaded from the `eProsima Fast DDS Github repository `_.
Grant Section
diff --git a/docs/fastdds/transport/shared_memory/shared_memory.rst b/docs/fastdds/transport/shared_memory/shared_memory.rst
index 84aa15dca2..083dde7d25 100644
--- a/docs/fastdds/transport/shared_memory/shared_memory.rst
+++ b/docs/fastdds/transport/shared_memory/shared_memory.rst
@@ -269,6 +269,6 @@ Delivery Mechanisms example
---------------------------
A hello world example suitable for supported delivery mechanisms can be found in the
-`delivery_mechanisms folder `_.
+:fastdds-tree:`delivery_mechanisms folder `.
It shows a publisher and a subscriber that communicate through the desired delivery mechanism (which can be set to
shared memory only).
diff --git a/docs/fastdds/transport/tcp/tcp.rst b/docs/fastdds/transport/tcp/tcp.rst
index a6d9eda87d..5d7c80c160 100644
--- a/docs/fastdds/transport/tcp/tcp.rst
+++ b/docs/fastdds/transport/tcp/tcp.rst
@@ -461,6 +461,6 @@ Delivery Mechanisms example
---------------------------
A hello world example suitable for supported delivery mechanisms can be found in the
-`delivery_mechanisms folder `_.
+:fastdds-tree:`delivery_mechanisms folder `.
It shows a publisher and a subscriber that communicate through the desired delivery mechanism (which can be set to TCP
only).
diff --git a/docs/fastdds/use_cases/request_reply/request_reply.rst b/docs/fastdds/use_cases/request_reply/request_reply.rst
index 9fe1509e7b..fb90d07274 100644
--- a/docs/fastdds/use_cases/request_reply/request_reply.rst
+++ b/docs/fastdds/use_cases/request_reply/request_reply.rst
@@ -49,7 +49,7 @@ The DDS communication schema will be:
The key for making *Request-Reply* work is relating the Request with the Reply in the client's side.
*Fast DDS* API provides |SampleIdentity-api| to achieve this.
-A full example can be found in `Fast DDS repository`_.
+A full example can be found in the :fastdds-tree:`Fast DDS repository `.
Getting started
---------------
@@ -147,4 +147,3 @@ For this the client application has to compare the stored |SampleIdentity-api| w
:start-after: //REQUEST_REPLY_EXAMPLE_CLIENT_RECEIVE_REPLY
:end-before: //!
-.. _Fast DDS repository: https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/request_reply
diff --git a/docs/fastdds/use_cases/statistics_module/statistics_module.rst b/docs/fastdds/use_cases/statistics_module/statistics_module.rst
index 7c832c45aa..3a9da64df4 100644
--- a/docs/fastdds/use_cases/statistics_module/statistics_module.rst
+++ b/docs/fastdds/use_cases/statistics_module/statistics_module.rst
@@ -38,7 +38,7 @@ another application should be configured to subscribe to those topics.
This application is a DDS standard application where the statistics DataReaders should be created.
In order to create these statistics DataReaders, the user should follow the next steps:
-* Using the `statistics IDL `_
+* Using the :fastdds-blob:`statistics IDL `
provided in the public API, generate the |TopicDataTypes-api| with :ref:`Fast DDS-Gen `.
* Create the |DomainParticipant-api| and register the |TopicDataTypes-api| and the corresponding statistics
diff --git a/docs/fastdds/use_cases/well_known_deployments/well_known_deployments.rst b/docs/fastdds/use_cases/well_known_deployments/well_known_deployments.rst
index b641970451..61c7a6cad5 100644
--- a/docs/fastdds/use_cases/well_known_deployments/well_known_deployments.rst
+++ b/docs/fastdds/use_cases/well_known_deployments/well_known_deployments.rst
@@ -48,7 +48,7 @@ each other, so they can start sharing user data right away, avoiding the EDP pha
A complete description of the feature can be found at :ref:`discovery_static`.
There is also a fully functional hello world example implementing STATIC EDP in the
-`examples/cpp/static_edp_discovery `_
+:fastdds-tree:`examples/cpp/static_edp_discovery `
folder.
The following subsections present an example configuration where a Publisher in
diff --git a/docs/fastdds/use_cases/zero_copy/zero_copy.rst b/docs/fastdds/use_cases/zero_copy/zero_copy.rst
index d0287d77c2..6c232c47cc 100644
--- a/docs/fastdds/use_cases/zero_copy/zero_copy.rst
+++ b/docs/fastdds/use_cases/zero_copy/zero_copy.rst
@@ -164,6 +164,6 @@ Next steps
----------
A hello world example suitable for supported delivery mechanisms can be found in the
-`delivery_mechanisms folder `_.
+:fastdds-tree:`delivery_mechanisms folder `.
It shows a publisher and a subscriber that communicate through the desired delivery mechanism.
As long as it is zero-copy compatible, both intra-process and data-sharing delivery mechanisms are zero-copy if used.
diff --git a/docs/fastdds/xml_configuration/making_xml_profiles.rst b/docs/fastdds/xml_configuration/making_xml_profiles.rst
index 33fd7a8880..b73ba7e1b3 100644
--- a/docs/fastdds/xml_configuration/making_xml_profiles.rst
+++ b/docs/fastdds/xml_configuration/making_xml_profiles.rst
@@ -38,7 +38,7 @@ The following sections will show implementation examples for each of these profi
The :ref:`examplexml` section shows an XML file with all the possible configurations and profile types.
This example is useful as a quick reference to look for a particular property and how to use it.
The
- `Fast DDS XSD scheme `_
+ :fastdds-blob:`Fast DDS XSD scheme `
can be used as a quick reference too.
.. _loadingapplyingprofiles:
@@ -218,6 +218,6 @@ It also gives the participant a name that mixes literal text with the content fr
.. warning::
- The `Fast DDS XSD schema `_
+ The :fastdds-blob:`Fast DDS XSD schema `
does not support the environment variables expansion feature, so validation of an XML file with environment
variables expansion expressions will fail.
diff --git a/docs/fastddsgen/pubsub_app/includes/sum_and_next_steps.rst b/docs/fastddsgen/pubsub_app/includes/sum_and_next_steps.rst
index 2582884993..f523c7e344 100644
--- a/docs/fastddsgen/pubsub_app/includes/sum_and_next_steps.rst
+++ b/docs/fastddsgen/pubsub_app/includes/sum_and_next_steps.rst
@@ -5,6 +5,6 @@ In this tutorial, a publisher/subscriber DDS application using *Fast DDS-Gen* ha
The tutorial also describes how to generate IDL files that contain the description of the Topic data type.
To continue developing DDS applications please take a look at the
-`eProsima Fast DDS examples on github `_
+:fastdds-tree:`eProsima Fast DDS examples on github `
for ideas on how to improve this basic application through different configuration
options, and also for examples of advanced *Fast DDS* features.
diff --git a/docs/fastddsgen/rpc_calculator_basic_app/includes/app.rst b/docs/fastddsgen/rpc_calculator_basic_app/includes/app.rst
index 127e9c847d..9aeb364aab 100644
--- a/docs/fastddsgen/rpc_calculator_basic_app/includes/app.rst
+++ b/docs/fastddsgen/rpc_calculator_basic_app/includes/app.rst
@@ -91,8 +91,7 @@ by specifying the operation name and through the CLI, and the results
will be printed on the screen after receiving the reply from the server.
Create a ``CalculatorClient.cpp`` file with this
-`content `_:
+:fastdds-docs-tree:`content `:
Examining the code
""""""""""""""""""
diff --git a/docs/fastddsgen/rpc_calculator_basic_app/intro.rst b/docs/fastddsgen/rpc_calculator_basic_app/intro.rst
index 0d3f9b1005..48b001381b 100644
--- a/docs/fastddsgen/rpc_calculator_basic_app/intro.rst
+++ b/docs/fastddsgen/rpc_calculator_basic_app/intro.rst
@@ -20,7 +20,7 @@ to call asynchronously the following operations:
* **representation_limits**: Returns the minimum and maximum representable values for a 32-bit integer.
The entire example source code is available in this
-`link `_
+:fastdds-docs-tree:`link `
.. include:: includes/background.rst
.. include:: includes/prerequisites.rst
diff --git a/docs/fastddsgen/rpc_calculator_feed_app/includes/app.rst b/docs/fastddsgen/rpc_calculator_feed_app/includes/app.rst
index 1e029cc4bb..864f9a8221 100644
--- a/docs/fastddsgen/rpc_calculator_feed_app/includes/app.rst
+++ b/docs/fastddsgen/rpc_calculator_feed_app/includes/app.rst
@@ -27,8 +27,7 @@ Client application
The client application extends the functionality of the basic example by adding the new operations
defined in the IDL file. Create a ``CalculatorClient.cpp`` file with this
-`content `_:
+:fastdds-docs-tree:`content `:
Examining the code
""""""""""""""""""
diff --git a/docs/fastddsgen/rpc_calculator_feed_app/intro.rst b/docs/fastddsgen/rpc_calculator_feed_app/intro.rst
index 4dc1a1b145..8d02502647 100644
--- a/docs/fastddsgen/rpc_calculator_feed_app/intro.rst
+++ b/docs/fastddsgen/rpc_calculator_feed_app/intro.rst
@@ -18,7 +18,7 @@ This section extends the previously discussed example of a calculator service
* **filter**: Returns a feed of results with the received values that match an input filter.
The entire example source code is available in this
-`link `_
+:fastdds-docs-tree:`link `
.. include:: includes/background.rst
.. include:: includes/workspace.rst
diff --git a/docs/fastddsgen/usage/usage.rst b/docs/fastddsgen/usage/usage.rst
index 5f121c2173..fd43f9f01b 100644
--- a/docs/fastddsgen/usage/usage.rst
+++ b/docs/fastddsgen/usage/usage.rst
@@ -75,7 +75,7 @@ Where the options are:
- Specifies a custom template used for generating source code.
This option expects the location of the template and the location of the file where source code output will be
stored.
- A custom template example can be found in this `link `_
+ A custom template example can be found in this :fastddsgen-raw:`link `
* - -flat-output-dir
- Ignores input files relative paths and place all generated files in the specified output directory.
* - -help
diff --git a/docs/installation/configuration/cmake_options.rst b/docs/installation/configuration/cmake_options.rst
index 10ceee90dc..898122360b 100644
--- a/docs/installation/configuration/cmake_options.rst
+++ b/docs/installation/configuration/cmake_options.rst
@@ -88,8 +88,8 @@ dependency on other options.
* - :class:`COMPILE_EXAMPLES`
- Builds the *Fast DDS* examples. It is set to ``ON`` if :class:`EPROSIMA_BUILD` is ``ON`` and
:class:`EPROSIMA_INSTALLER` is ``OFF``. These examples can be found in the
- `eProsima Fast DDS `_
- `GitHub repository `_.
+ :fastdds-tree:`eProsima Fast DDS `
+ :fastdds-tree:`GitHub repository `.
- ``ON`` ``OFF``
- ``OFF``
* - :class:`INSTALL_EXAMPLES`
diff --git a/docs/installation/sources/sources_linux.rst b/docs/installation/sources/sources_linux.rst
index e3cc5ec0d9..e91f40983b 100644
--- a/docs/installation/sources/sources_linux.rst
+++ b/docs/installation/sources/sources_linux.rst
@@ -215,10 +215,11 @@ This section explains how to use it to compile *eProsima Fast DDS* and its depen
*eProsima Fast DDS* and its dependencies:
.. code-block:: bash
+ :substitutions:
mkdir ~/Fast-DDS
cd ~/Fast-DDS
- wget https://raw.githubusercontent.com/eProsima/Fast-DDS/master/fastdds.repos
+ wget https://raw.githubusercontent.com/eProsima/Fast-DDS/|FastDDSBranch|/fastdds.repos
mkdir src
vcs import src < fastdds.repos
@@ -433,10 +434,11 @@ This section explains how to use it to compile *Fast DDS Python bindings* and it
*Fast DDS Python bindings* and its dependencies:
.. code-block:: bash
+ :substitutions:
mkdir ~/Fast-DDS-python
cd ~/Fast-DDS-python
- wget https://raw.githubusercontent.com/eProsima/Fast-DDS-python/main/fastdds_python.repos
+ wget https://raw.githubusercontent.com/eProsima/Fast-DDS-python/|FastDDSPythonBranch|/fastdds_python.repos
mkdir src
vcs import src < fastdds_python.repos
diff --git a/docs/installation/sources/sources_mac.rst b/docs/installation/sources/sources_mac.rst
index b60b5685e1..6f6015c8d1 100644
--- a/docs/installation/sources/sources_mac.rst
+++ b/docs/installation/sources/sources_mac.rst
@@ -166,10 +166,11 @@ This section explains how to use it to compile *eProsima Fast DDS* and its depen
*eProsima Fast DDS* and its dependencies:
.. code-block:: bash
+ :substitutions:
mkdir ~/Fast-DDS
cd ~/Fast-DDS
- wget https://raw.githubusercontent.com/eProsima/Fast-DDS/master/fastdds.repos
+ wget https://raw.githubusercontent.com/eProsima/Fast-DDS/|FastDDSBranch|/fastdds.repos
mkdir src
vcs import src < fastdds.repos
diff --git a/docs/installation/sources/sources_windows.rst b/docs/installation/sources/sources_windows.rst
index 973b4773c0..5996d9791d 100644
--- a/docs/installation/sources/sources_windows.rst
+++ b/docs/installation/sources/sources_windows.rst
@@ -268,10 +268,11 @@ This section explains how to use it to compile *eProsima Fast DDS* and its depen
*eProsima Fast DDS* and its dependencies:
.. code-block:: winbatch
+ :substitutions:
mkdir ~\Fast-DDS
cd ~\Fast-DDS
- wget https://raw.githubusercontent.com/eProsima/Fast-DDS/master/fastdds.repos -output fastdds.repos
+ wget https://raw.githubusercontent.com/eProsima/Fast-DDS/|FastDDSBranch|/fastdds.repos -output fastdds.repos
mkdir src
vcs import src --input fastdds.repos
@@ -465,10 +466,11 @@ This section explains how to use it to compile *Fast DDS Python bindings* and it
*Fast DDS Python bindings* and its dependencies:
.. code-block:: winbatch
+ :substitutions:
mkdir ~\Fast-DDS-python
cd ~\Fast-DDS-python
- wget https://raw.githubusercontent.com/eProsima/Fast-DDS-python/main/fastdds_python.repos
+ wget https://raw.githubusercontent.com/eProsima/Fast-DDS-python/|FastDDSPythonBranch|/fastdds_python.repos
mkdir src
vcs import src --input fastdds_python.repos
diff --git a/docs/notes/migration_guide.rst b/docs/notes/migration_guide.rst
index 50e8bcf661..ab5944cf9d 100644
--- a/docs/notes/migration_guide.rst
+++ b/docs/notes/migration_guide.rst
@@ -401,4 +401,4 @@ Step 9: Examples refactor
All examples in the Fast DDS project have been refactored to follow a consistent structure, having renamed files,
restructured classes, and updated the overall format. If you have integrated any example into your
own implementation, carefully review the updated examples to ensure compatibility with your project. As reference,
-consider the example `Configuration `_.
+consider the example :fastdds-tree:`Configuration `.
diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst
index 6d331797fc..217b2d903a 100644
--- a/docs/notes/notes.rst
+++ b/docs/notes/notes.rst
@@ -3,7 +3,7 @@
.. _release_notes:
Information about the release lifecycle can be found
-`here `_.
+:fastdds-blob:`here `.
.. include:: previous_versions/v3.4.2.rst
diff --git a/docs/notes/previous_versions/v2.6.10.rst b/docs/notes/previous_versions/v2.6.10.rst
index d1ff4c60e2..269ac49fdd 100644
--- a/docs/notes/previous_versions/v2.6.10.rst
+++ b/docs/notes/previous_versions/v2.6.10.rst
@@ -3,7 +3,7 @@
.. important::
According to our
- `release support guidelines `_
+ :fastdds-blob:`release support guidelines `
the v2.6 minor will only receive patches for critical issues and security fixes.
This release includes the following **critical fixes**:
diff --git a/docs/notes/previous_versions/v2.6.11.rst b/docs/notes/previous_versions/v2.6.11.rst
index e808a6faeb..992aa4d456 100644
--- a/docs/notes/previous_versions/v2.6.11.rst
+++ b/docs/notes/previous_versions/v2.6.11.rst
@@ -3,7 +3,7 @@
.. important::
According to our
- `release support guidelines `_
+ :fastdds-blob:`release support guidelines `
the v2.6 minor will only receive patches for critical issues and security fixes.
This release includes the following **critical fixes**:
diff --git a/docs/notes/previous_versions/v2.6.9.rst b/docs/notes/previous_versions/v2.6.9.rst
index 9ab7895f8b..3d0fa3605d 100644
--- a/docs/notes/previous_versions/v2.6.9.rst
+++ b/docs/notes/previous_versions/v2.6.9.rst
@@ -3,7 +3,7 @@
.. important::
According to our
- `release support guidelines `_
+ :fastdds-blob:`release support guidelines `
Fast DDS v2.6.9 will be the last patch version receiving backported features and bugfixes.
From now on, the v2.6 minor will only receive patches for critical issues and security fixes.
diff --git a/docs/notes/previous_versions/v3.0.0.rst b/docs/notes/previous_versions/v3.0.0.rst
index e2da2673c9..92d1148f85 100644
--- a/docs/notes/previous_versions/v3.0.0.rst
+++ b/docs/notes/previous_versions/v3.0.0.rst
@@ -3,7 +3,7 @@
Fast DDS v3.0.0 is a mayor release that entails some **API breaks** and new features.
This version is **not backwards compatible** with previous versions.
-Refer to the `migration guide `__ for hints moving to Fast DDS v3.0.0.
+Refer to the :fastdds-blob:`migration guide ` for hints moving to Fast DDS v3.0.0.
This release includes the following **API breaks**:
@@ -27,7 +27,7 @@ This release includes the following **API breaks**:
#. Move ``DataReader::TypeConsistencyEnforcement`` and ``DataReader::DataRepresentation`` from ``TypeConsistency`` to ``DataReaderQos``.
#. Migrate ``BuiltinEndpoints`` defines to variables.
#. Remove ``string_convert`` header and source.
-#. `Examples `__ refactor.
+#. :fastdds-blob:`Examples ` refactor.
#. Update Fast DDS docs QoS examples.
#. Link SHM locator kind with Fast DDS major version.
#. Discard local SHM locators that cannot be opened.
@@ -56,7 +56,7 @@ This release includes the following **improvements**:
#. Setting ``vendor_id`` on received ``CacheChange_t``.
#. Builtin data related improvements.
#. GitHub repository management.
-#. `Migration guide `__.
+#. :fastdds-blob:`Migration guide `.
#. Update fastcdr thirdparty.
#. Documentation updates due to major version change.
diff --git a/docs/notes/versions.rst b/docs/notes/versions.rst
index b538635faf..e526a276ee 100644
--- a/docs/notes/versions.rst
+++ b/docs/notes/versions.rst
@@ -360,7 +360,7 @@ The following table shows the minimum version required of the Fast DDS build sys
.. important::
According to our
- `release support guidelines `_
+ :fastdds-blob:`release support guidelines `
Fast DDS v2.6.9 will be the last patch version receiving backported features and bugfixes.
From now on, the v2.6 minor will only receive patches for critical issues and security fixes.
@@ -470,7 +470,7 @@ The following table shows the corresponding versions of the Fast DDS library dep
.. important::
According to our
- `release support guidelines `_
+ :fastdds-blob:`release support guidelines `
Fast DDS v2.6.9 will be the last patch version receiving backported features and bugfixes.
From now on, the v2.6 minor will only receive patches for critical issues and security fixes.
@@ -581,6 +581,6 @@ Fast DDS as the core middleware.
.. important::
According to our
- `release support guidelines `_
+ :fastdds-blob:`release support guidelines `
Fast DDS v2.6.9 will be the last patch version receiving backported features and bugfixes.
From now on, the v2.6 minor will only receive patches for critical issues and security fixes.