Add logo #2853
Add logo #2853
Conversation
| IN THE SOFTWARE. | ||
|
|
||
| THE USAGE OF THIS LOGO AND ARTWORK DOES NOT INDICATE ENDORSEMENT BY THE | ||
| SETUPTOOLS PROJECT. |
There was a problem hiding this comment.
The main reason why I added this second copyright notice, was to have the last phrase:
THE USAGE OF THIS LOGO AND ARTWORK DOES NOT INDICATE ENDORSEMENT BY THE
SETUPTOOLS PROJECT.
I think it make sense... but we can also remove this and just rely on the license note on the root directory.
(Inspired by https://flask.palletsprojects.com/en/1.1.x/license/#artwork-license)
| setuptools | ||
|
|
||
| .. toctree:: |
There was a problem hiding this comment.
This is just a suggestion on how to organise the sidebar in 2 logical sections: one that targets directly the end user and one that is more "meta" regarding the project...
| Development guide <development/index> | ||
| Backward compatibility & deprecated practice <deprecated/index> | ||
| Changelog <history> | ||
| Artwork <images/README> |
There was a problem hiding this comment.
I don't know exactly where to place it, so I added it here, but no strong preference...
|
Beautiful, inspired. I love it. |
| @@ -101,6 +101,19 @@ | |||
|
|
|||
| # HTML theme | |||
| html_theme = 'furo' | |||
| html_logo = "images/logo.png" | |||
There was a problem hiding this comment.
I'd recommend not to add blobs into the repo. Sphinx and any other modern web tool works with SVG just fine. Besides poisoning the Git bare repo size, it can also look ugly when scaled for folks with 200% default browser zoom (I have this, for example) + SVG is more optimized for the network transfer meaning faster page loads.
There was a problem hiding this comment.
Thanks for the feedback @webknjaz. In the PR I added a few PNGs as requested in the discussion of the original issue.
I can submit a PR removing the binary files and replacing them with the SVGs in the *.rst if you guys think that is the best action forward. (If you prefer, and Github allow, you can even open an issue and assign it to me).
I have one doubt regarding the favicon. I suppose modern browsers can handle SVG favicons well, but I don't know if that will work with sphinx out of the box. I suspect sphinx-favicon can handle that scenario. If that is ok with the mantainers, I can also investigate sphinx-favicon and remove the ".ico" file.
Apparently SVG favicons are not supported in Saffari (https://caniuse.com/link-icon-svg)
There was a problem hiding this comment.
I'd also prefer relying on vector graphics where possible. Sounds like the favicon may not work, so use your judgment.
Summary of changes
The banners were create in the size 640x320 to fit GitHub's preview (but the SVG images can be rescaled as necessary)
Closes #2227
Pull Request Checklist
changelog.d/.(See documentation for details)