Fix pull-request.yml build errors by addressing Sphinx warnings and adding missing label definition #508
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Per build warning; WARNING: Calling get_html_theme_path is deprecated. If you are calling it to define html_theme_path, you are safe to remove that code. So removing the code to get rid of warning. Signed-off-by: Christopher Turner <christopher.g.turner@intel.com>
the option for display_version for the sphinx-rtd-theme was deprecated since v3.0.0 Signed-off-by: Christopher Turner <christopher.g.turner@intel.com>
cgturner1
changed the title
cgturner1
requested review from
deb-intel,
intelkevinputnam,
lgirdwood,
mmaka1 and
mwasko
as code owners
lyakh
requested changes
Feb 20, 2025
|
|
||
| Installation | ||
| ************ | ||
| .. _intel_firmware_paths: |
Contributor
There was a problem hiding this comment.
no, it isn't supposed to be here, it was removed by 0576be4#diff-8a57b48ec6926ea189c9ca3cf80b81def022dd4d1a55c6be760f6892d92255d8L165
Contributor
There was a problem hiding this comment.
that commit removed it from getting_started/intel_debug/introduction.rst not from the llext_modules.rst.
I guess the link in line 81/82 should be changed to _intel_modular_firmware_paths
Contributor
Author
There was a problem hiding this comment.
thanks for taking a look hadn't seen the history (should've double checked that) will make the necessary changes then
Contributor
Author
There was a problem hiding this comment.
ok updated with the link to intel_modular_firmware_paths and removed previous changes that were incorrect
…mware paths update broken link to Intel firmware paths in llext_modules.rst from intel_firmware_paths to intel_modular_firmware_paths to point to correct location and fix doc build errors. Signed-off-by: Christopher Turner <christopher.g.turner@intel.com>
ujfalusi
approved these changes
Feb 21, 2025
lyakh
approved these changes
Feb 21, 2025
lgirdwood
approved these changes
Feb 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request addresses the build errors caused by Sphinx warnings and a missing label definition in the documentation. The following changes have been made:
Update link to for
intel_modular_firmware_paths:intel_firmware_pathstointel_modular_firmware_pathsindeveloper_guides/firmware/llext_modules.rstto resolve the docs build error.Remove deprecated
display_versionconfiguration:display_versionoption fromhtml_theme_optionsinconf.pyas it was deprecated insphinx-rtd-themesince v3.0.0.Remove unused
html_theme_pathconfiguration:html_theme_pathconfiguration fromconf.pyto get rid of the deprecation warning.These changes should resolve the build errors and ensure that the documentation builds successfully without warnings.
Changes
developer_guides/firmware/llext_modules.rst: Fixed link tointel_modular_firmware_paths.conf.py: Removed deprecateddisplay_versionconfiguration and unusedhtml_theme_pathconfiguration.Signed-off-by
Christopher Turner christopher.g.turner@intel.com