mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge pull request #9381 from tronical/logo-url-fix
Fix support for html logo and favicon as url
This commit is contained in:
commit
83f60d4045
@ -468,9 +468,6 @@ class StandaloneHTMLBuilder(Builder):
|
|||||||
else:
|
else:
|
||||||
self.last_updated = None
|
self.last_updated = None
|
||||||
|
|
||||||
logo = path.basename(self.config.html_logo) if self.config.html_logo else ''
|
|
||||||
favicon = path.basename(self.config.html_favicon) if self.config.html_favicon else ''
|
|
||||||
|
|
||||||
self.relations = self.env.collect_relations()
|
self.relations = self.env.collect_relations()
|
||||||
|
|
||||||
rellinks: List[Tuple[str, str, str, str]] = []
|
rellinks: List[Tuple[str, str, str, str]] = []
|
||||||
@ -513,8 +510,8 @@ class StandaloneHTMLBuilder(Builder):
|
|||||||
'rellinks': rellinks,
|
'rellinks': rellinks,
|
||||||
'builder': self.name,
|
'builder': self.name,
|
||||||
'parents': [],
|
'parents': [],
|
||||||
'logo': logo,
|
'logo': self.config.html_logo or '',
|
||||||
'favicon': favicon,
|
'favicon': self.config.html_favicon or '',
|
||||||
'html5_doctype': html5_ready and not self.config.html4_writer,
|
'html5_doctype': html5_ready and not self.config.html4_writer,
|
||||||
}
|
}
|
||||||
if self.theme:
|
if self.theme:
|
||||||
|
5
tests/roots/test-remote-logo/conf.py
Normal file
5
tests/roots/test-remote-logo/conf.py
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
latex_documents = [
|
||||||
|
('index', 'test.tex', 'The basic Sphinx documentation for testing', 'Sphinx', 'report')
|
||||||
|
]
|
||||||
|
html_logo = "https://www.python.org/static/img/python-logo.png"
|
||||||
|
html_favicon = "https://www.python.org/static/favicon.ico"
|
32
tests/roots/test-remote-logo/index.rst
Normal file
32
tests/roots/test-remote-logo/index.rst
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
The basic Sphinx documentation for testing
|
||||||
|
==========================================
|
||||||
|
|
||||||
|
Sphinx is a tool that makes it easy to create intelligent and beautiful
|
||||||
|
documentation for Python projects (or other documents consisting of multiple
|
||||||
|
reStructuredText sources), written by Georg Brandl. It was originally created
|
||||||
|
for the new Python documentation, and has excellent facilities for Python
|
||||||
|
project documentation, but C/C++ is supported as well, and more languages are
|
||||||
|
planned.
|
||||||
|
|
||||||
|
Sphinx uses reStructuredText as its markup language, and many of its strengths
|
||||||
|
come from the power and straightforwardness of reStructuredText and its parsing
|
||||||
|
and translating suite, the Docutils.
|
||||||
|
|
||||||
|
features
|
||||||
|
--------
|
||||||
|
|
||||||
|
Among its features are the following:
|
||||||
|
|
||||||
|
* Output formats: HTML (including derivative formats such as HTML Help, Epub
|
||||||
|
and Qt Help), plain text, manual pages and LaTeX or direct PDF output
|
||||||
|
using rst2pdf
|
||||||
|
* Extensive cross-references: semantic markup and automatic links
|
||||||
|
for functions, classes, glossary terms and similar pieces of information
|
||||||
|
* Hierarchical structure: easy definition of a document tree, with automatic
|
||||||
|
links to siblings, parents and children
|
||||||
|
* Automatic indices: general index as well as a module index
|
||||||
|
* Code handling: automatic highlighting using the Pygments highlighter
|
||||||
|
* Flexible HTML output using the Jinja 2 templating engine
|
||||||
|
* Various extensions are available, e.g. for automatic testing of snippets
|
||||||
|
and inclusion of appropriately formatted docstrings
|
||||||
|
* Setuptools integration
|
@ -1330,6 +1330,16 @@ def test_html_remote_images(app, status, warning):
|
|||||||
assert not (app.outdir / 'python-logo.png').exists()
|
assert not (app.outdir / 'python-logo.png').exists()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.sphinx('html', testroot='remote-logo')
|
||||||
|
def test_html_remote_logo(app, status, warning):
|
||||||
|
app.builder.build_all()
|
||||||
|
|
||||||
|
result = (app.outdir / 'index.html').read_text()
|
||||||
|
assert ('<img class="logo" src="https://www.python.org/static/img/python-logo.png" alt="Logo"/>' in result)
|
||||||
|
assert ('<link rel="shortcut icon" href="https://www.python.org/static/favicon.ico"/>' in result)
|
||||||
|
assert not (app.outdir / 'python-logo.png').exists()
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.sphinx('html', testroot='basic')
|
@pytest.mark.sphinx('html', testroot='basic')
|
||||||
def test_html_sidebar(app, status, warning):
|
def test_html_sidebar(app, status, warning):
|
||||||
ctx = {}
|
ctx = {}
|
||||||
|
Loading…
Reference in New Issue
Block a user