summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CHANGES1
-rw-r--r--sphinx/writers/latex.py2
-rw-r--r--tests/test_build_latex.py18
3 files changed, 18 insertions, 3 deletions
diff --git a/CHANGES b/CHANGES
index d9350d21a..b3e6283fd 100644
--- a/CHANGES
+++ b/CHANGES
@@ -113,6 +113,7 @@ Bugs fixed
* #4198: autosummary emits multiple 'autodoc-process-docstring' event. Thanks
to Joel Nothman.
* #4081: Warnings and errors colored the same when building
+* latex: Do not display 'Release' label if :confval:`release` is not set
Testing
--------
diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py
index de472b36c..6c86e6174 100644
--- a/sphinx/writers/latex.py
+++ b/sphinx/writers/latex.py
@@ -549,7 +549,7 @@ class LaTeXTranslator(nodes.NodeVisitor):
'author': document.settings.author, # treat as a raw LaTeX code
'indexname': _('Index'),
})
- if not self.elements['releasename']:
+ if not self.elements['releasename'] and self.elements['release']:
self.elements.update({
'releasename': _('Release'),
})
diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py
index ab91d7a48..e7b61ad0c 100644
--- a/tests/test_build_latex.py
+++ b/tests/test_build_latex.py
@@ -165,13 +165,15 @@ def test_latex_warnings(app, status, warning):
@pytest.mark.sphinx('latex', testroot='basic')
-def test_latex_title(app, status, warning):
+def test_latex_basic(app, status, warning):
app.builder.build_all()
result = (app.outdir / 'test.tex').text(encoding='utf8')
print(result)
print(status.getvalue())
print(warning.getvalue())
- assert '\\title{The basic Sphinx documentation for testing}' in result
+ assert r'\title{The basic Sphinx documentation for testing}' in result
+ assert r'\release{}' in result
+ assert r'\renewcommand{\releasename}{}' in result
@pytest.mark.sphinx('latex', testroot='latex-title')
@@ -184,6 +186,18 @@ def test_latex_title_after_admonitions(app, status, warning):
assert '\\title{test-latex-title}' in result
+@pytest.mark.sphinx('latex', testroot='basic',
+ confoverrides={'release': '1.0'})
+def test_latex_release(app, status, warning):
+ app.builder.build_all()
+ result = (app.outdir / 'test.tex').text(encoding='utf8')
+ print(result)
+ print(status.getvalue())
+ print(warning.getvalue())
+ assert r'\release{1.0}' in result
+ assert r'\renewcommand{\releasename}{Release}' in result
+
+
@pytest.mark.sphinx('latex', testroot='numfig',
confoverrides={'numfig': True})
def test_numref(app, status, warning):