IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc: html_favicon and html_logo accept URL now

Browse Source
This commit is contained in:
Takeshi KOMIYA 2021-01-23 20:49:15 +09:00
parent 76d0a0be82
commit 7cfcd81b76
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/usage/configuration.rst
View File

@ -987,26 +987,32 @@ that use Sphinx's HTMLWriter class.
.. confval:: html_logo .. confval:: html_logo
If given, this must be the name of an image file (path relative to the If given, this must be the name of an image file (path relative to the
:term:`configuration directory`) that is the logo of the docs. It is placed :term:`configuration directory`) that is the logo of the docs, or URL that
at the top of the sidebar; its width should therefore not exceed 200 pixels. points an image file for the logo. It is placed at the top of the sidebar;
Default: ``None``. its width should therefore not exceed 200 pixels. Default: ``None``.
.. versionadded:: 0.4.1 .. versionadded:: 0.4.1
The image file will be copied to the ``_static`` directory of the output The image file will be copied to the ``_static`` directory of the output
HTML, but only if the file does not already exist there. HTML, but only if the file does not already exist there.
.. versionchanged:: 4.0
Also accepts the URL for the logo file.
.. confval:: html_favicon .. confval:: html_favicon
If given, this must be the name of an image file (path relative to the If given, this must be the name of an image file (path relative to the
:term:`configuration directory`) that is the favicon of the docs. Modern :term:`configuration directory`) that is the favicon of the docs, or URL that
browsers use this as the icon for tabs, windows and bookmarks. It should points an image file for the favicon. Modern browsers use this as the icon
be a Windows-style icon file (``.ico``), which is 16x16 or 32x32 for tabs, windows and bookmarks. It should be a Windows-style icon file
pixels large. Default: ``None``. (``.ico``), which is 16x16 or 32x32 pixels large. Default: ``None``.
.. versionadded:: 0.4 .. versionadded:: 0.4
The image file will be copied to the ``_static`` directory of the output The image file will be copied to the ``_static`` directory of the output
HTML, but only if the file does not already exist there. HTML, but only if the file does not already exist there.
.. versionchanged:: 4.0
Also accepts the URL for the favicon.
.. confval:: html_css_files .. confval:: html_css_files
A list of CSS files. The entry must be a *filename* string or a tuple A list of CSS files. The entry must be a *filename* string or a tuple