Skip to content
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

Merged
merged 9 commits into from
May 14, 2021
Merged

Use an SVG logo across the docs #5678

merged 9 commits into from
May 14, 2021

Conversation

himanshu007-creator
Copy link
Contributor

@himanshu007-creator himanshu007-creator commented May 7, 2021

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

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .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.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

Sorry, something went wrong.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@webknjaz
Copy link
Member

webknjaz commented May 7, 2021

@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 docs/conf.py. Could you please include that change here too?

@himanshu007-creator
Copy link
Contributor Author

@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 docs/conf.py. Could you please include that change here too?

Will do it today👍

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@webknjaz
Copy link
Member

webknjaz commented May 8, 2021

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 html_logo var so sphinx would copy it to the static dir during the build.

@himanshu007-creator
Copy link
Contributor Author

himanshu007-creator commented May 8, 2021

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 html_logo var so sphinx would copy it to the static dir during the build.

okay, so i will create a var
html_logo="https://raw.githubusercontent.com/aio-libs/aiohttp/4d58400477331704132cc9427d66699e5815ee25/docs/aiohttp-plain.svg"

Then assign "logo":html_logo

is this the correct way?

@webknjaz
Copy link
Member

webknjaz commented May 8, 2021

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
Copy link

codecov bot commented May 9, 2021

Codecov Report

Merging #5678 (ffb2887) into master (4d58400) will not change coverage.
The diff coverage is n/a.

❗ Current head ffb2887 differs from pull request most recent head efc816f. Consider uploading reports for the commit efc816f to get more accurate results
Impacted file tree graph

@@           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           
Flag Coverage Δ
unit 97.06% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4d58400...efc816f. Read the comment docs.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@himanshu007-creator
Copy link
Contributor Author

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.

can you tell the required changes please

webknjaz and others added 5 commits May 14, 2021 23:56

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@webknjaz webknjaz changed the title Update README.rst Use an SVG logo across the docs May 14, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@webknjaz webknjaz merged commit 264a441 into aio-libs:master May 14, 2021
@patchback
Copy link
Contributor

patchback bot commented May 14, 2021

Backport to 3.8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.8/264a441acf7d0d01bf34c3bedbaf05b0e0bb43a6/pr-5678

Backported as #5712

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request May 14, 2021
* 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)
webknjaz pushed a commit that referenced this pull request May 14, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
)

* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TODO] Use an SVG logo in the Sphinx docs
2 participants