Added favicon to user documentation #18007
Draft
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
seanbudd
reviewed
Apr 28, 2025
seanbudd
reviewed
Apr 28, 2025
| @@ -331,6 +331,7 @@ for po in env.Glob(sourceDir.path + "/locale/*/lc_messages/*.po"): | |||
|
|
|||
There was a problem hiding this comment.
please also add a reference in
Line 312 in 495dee3
|
can this also please be rebased to beta? |
|
Rather than committing a new file, can you just use |
seanbudd
reviewed
Apr 28, 2025
| @@ -331,6 +331,7 @@ for po in env.Glob(sourceDir.path + "/locale/*/lc_messages/*.po"): | |||
|
|
|||
| styles = os.path.join(userDocsDir.path, "styles.css") | |||
| numberedHeadingsStyle = os.path.join(userDocsDir.path, "numberedHeadings.css") | |||
| logo = os.path.join(userDocsDir.path, "favicon.ico") | |||
There was a problem hiding this comment.
Suggested change
| logo = os.path.join(userDocsDir.path, "favicon.ico") | |
| logo = os.path.join(sourceDir.path, "images", "nvda.ico") |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Link to issue number:
Fixes #17971
Summary of the issue:
When loading NVDA HTML documentation in the browser, there's no page icon (favicon.ico).
Description of user facing changes:
The NVDA logo is visible when opening any .html file in the user_docs
Description of development approach:
I added a simple rel="shortcut icon" similar to nvaccess' website using the NVDA logo which I found here. I also changed the logic in sconstruct.py to make sure that the favicon is pulled locally in every subfolder and cleaned when running scons -c
Testing strategy:
Run .\scons.bat user_docs to generate the .html files and the favicon.ico
Run .\scons.bat -c user_docs to clear out the generated files
Known issues with pull request:
Code Review Checklist:
@coderabbitai summary