-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use an SVG logo across the docs #5678
Conversation
@himanshu007-creator thanks for looking into this. While I see that this change is useful, that issue was about the sphinx docs logo set in the |
Will do it today👍 |
Looks like more changes are needed to make this work. It currently generates a link to a non-existent file (which is visible here https://aiohttp--5678.org.readthedocs.build/en/5678/). I suppose it may be necessary to add an |
okay, so i will create a var Then assign is this the correct way? |
No, only use a file name in that var, no need to have a URL coupled to GitHub. Check the Sphinx docs for more details, if necessary. |
Codecov Report
@@ Coverage Diff @@
## master #5678 +/- ##
=======================================
Coverage 97.17% 97.17%
=======================================
Files 41 41
Lines 8865 8865
Branches 1425 1425
=======================================
Hits 8615 8615
Misses 133 133
Partials 117 117
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
can you tell the required changes please |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Backport to 3.8: 💚 backport PR created✅ Backport PR branch: Backported as #5712 🤖 @patchback |
* Update README.rst #5677 * Update conf.py * Update conf.py * Fix html_logo rel path in `conf.py` * Keep the branch name in the logo URI in README * Move html logo definition to the intended location * Add a custom CSS file * Create logo-adjustments.css * Drop the unused PNG logo from docs assets Co-authored-by: Sviatoslav Sydorenko <[email protected]> Co-authored-by: Sviatoslav Sydorenko <[email protected]> (cherry picked from commit 264a441)
) * Update README.rst #5677 * Update conf.py * Update conf.py * Fix html_logo rel path in `conf.py` * Keep the branch name in the logo URI in README * Move html logo definition to the intended location * Add a custom CSS file * Create logo-adjustments.css * Drop the unused PNG logo from docs assets Co-authored-by: Sviatoslav Sydorenko <[email protected]> Co-authored-by: Sviatoslav Sydorenko <[email protected]> (cherry picked from commit 264a441) Co-authored-by: Himanshu <[email protected]>
What do these changes do?
This patch switches the png logo with an SVG one.
Are there changes in behavior for the user?
The logo in the docs looks nicer when zoomed in.
Related issue number
Resolves #5677
Checklist
CONTRIBUTORS.txt
CHANGES
folder<issue_id>.<type>
for example (588.bugfix)issue_id
change it to the pr id after creating the pr.feature
: Signifying a new feature..bugfix
: Signifying a bug fix..doc
: Signifying a documentation improvement..removal
: Signifying a deprecation or removal of public API..misc
: A ticket has been closed, but it is not of interest to users.