Hi all,
I am trying to build docs with following commands:
cmake -S docs -B ./build_docs cmake --build build_docs/ -- tfm_docs_userguide_pdf
But I get following error resolving references... failed
Warning, treated as error: RSVG converter command 'rsvg-convert' cannot be run. Check the rsvg_converter_bin setting
When I remove -W (warnings are errors) option from
COMMAND "${SPHINX_EXECUTABLE}" -W -b html -j 1 -c ${SPHINXCFG_CONFIG_PATH} ${SPHINXCFG_SOURCE_PATH} "${SPHINXCFG_OUTPUT_PATH}/html"
In docs/CMakeLists.txt then docs builds fine.
Is this -W option intentional? Should this issue be fixed or -W removed?
Regards, Bohdan Hunko
Cypress Semiconductor Ukraine Engineer CSUKR CSS ICW SW FW Mobile: +38099 50 19 714 Bohdan.Hunko@infineon.commailto:Bohdan.Hunko@infineon.com
Hi Bohdan,
Yes, the -W option (treating warnings as errors) was added intentionally to ensure clean, warning-free documentation builds, so ideally we should aim to fix all issues. With the introduction of intersphinx, some reference-related warnings have become more difficult to resolve, especially when they involve links to other repositories or mismatched versions.
You may have noticed that the online documentation was building successfully until recently-this is because ReadTheDocs does not use the -W option by default. However, it broke today due to a separate issue. I'll investigate these problems and follow up once I have more information.
Best regards, Anton
From: Bohdan.Hunko--- via TF-M tf-m@lists.trustedfirmware.org Sent: Friday, May 30, 2025 8:32 AM To: tf-m@lists.trustedfirmware.org Subject: [TF-M] Issue building docs
Hi all,
I am trying to build docs with following commands:
cmake -S docs -B ./build_docs cmake --build build_docs/ -- tfm_docs_userguide_pdf
But I get following error resolving references... failed
Warning, treated as error: RSVG converter command 'rsvg-convert' cannot be run. Check the rsvg_converter_bin setting
When I remove -W (warnings are errors) option from
COMMAND "${SPHINX_EXECUTABLE}" -W -b html -j 1 -c ${SPHINXCFG_CONFIG_PATH} ${SPHINXCFG_SOURCE_PATH} "${SPHINXCFG_OUTPUT_PATH}/html"
In docs/CMakeLists.txt then docs builds fine.
Is this -W option intentional? Should this issue be fixed or -W removed?
Regards, Bohdan Hunko
Cypress Semiconductor Ukraine Engineer CSUKR CSS ICW SW FW Mobile: +38099 50 19 714 Bohdan.Hunko@infineon.commailto:Bohdan.Hunko@infineon.com
Hi Bohdan,
It's likely that your Linux setup is missing the rsvg-convert tool from the librsvg2 package, which is required for generating graphics in PDF. You can install the necessary dependencies by running:
sudo apt-get install -y doxygen-latex librsvg2-bin as described in our documentation: Tools and Building Environment - Trusted Firmware-M Docshttps://trustedfirmware-m.readthedocs.io/en/latest/building/documentation_generation.html#tools-and-building-environment
By the way, the other issue on ReadTheDocs today was likely due to a temporary network problem, as the rebuild completed successfully.
Does it help? Anton
From: Anton Komlev via TF-M tf-m@lists.trustedfirmware.org Sent: Friday, May 30, 2025 10:28 AM To: Bohdan.Hunko@infineon.com; tf-m@lists.trustedfirmware.org Subject: [TF-M] Re: Issue building docs
Hi Bohdan,
Yes, the -W option (treating warnings as errors) was added intentionally to ensure clean, warning-free documentation builds, so ideally we should aim to fix all issues. With the introduction of intersphinx, some reference-related warnings have become more difficult to resolve, especially when they involve links to other repositories or mismatched versions.
You may have noticed that the online documentation was building successfully until recently-this is because ReadTheDocs does not use the -W option by default. However, it broke today due to a separate issue. I'll investigate these problems and follow up once I have more information.
Best regards, Anton
From: Bohdan.Hunko--- via TF-M <tf-m@lists.trustedfirmware.orgmailto:tf-m@lists.trustedfirmware.org> Sent: Friday, May 30, 2025 8:32 AM To: tf-m@lists.trustedfirmware.orgmailto:tf-m@lists.trustedfirmware.org Subject: [TF-M] Issue building docs
Hi all,
I am trying to build docs with following commands:
cmake -S docs -B ./build_docs cmake --build build_docs/ -- tfm_docs_userguide_pdf
But I get following error resolving references... failed
Warning, treated as error: RSVG converter command 'rsvg-convert' cannot be run. Check the rsvg_converter_bin setting
When I remove -W (warnings are errors) option from
COMMAND "${SPHINX_EXECUTABLE}" -W -b html -j 1 -c ${SPHINXCFG_CONFIG_PATH} ${SPHINXCFG_SOURCE_PATH} "${SPHINXCFG_OUTPUT_PATH}/html"
In docs/CMakeLists.txt then docs builds fine.
Is this -W option intentional? Should this issue be fixed or -W removed?
Regards, Bohdan Hunko
Cypress Semiconductor Ukraine Engineer CSUKR CSS ICW SW FW Mobile: +38099 50 19 714 Bohdan.Hunko@infineon.commailto:Bohdan.Hunko@infineon.com
tf-m@lists.trustedfirmware.org