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

Merged in tk0miya/sphinx (pull request #266)

Browse Source 
Rename :filename: option of code-block directive to :caption:
This commit is contained in:
Takayuki Shimizukawa 2014-08-24 11:02:36 +09:00
commit 8536b4844e
13 changed files with 89 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
sphinx/directives/code.py
View File

@ -77,7 +77,7 @@ class CodeBlock(Directive):
'dedent': int,
'lineno-start': int,
'emphasize-lines': directives.unchanged_required,
'filename': directives.unchanged_required,
'caption': directives.unchanged_required,
}
def run(self):
@ -101,9 +101,9 @@ class CodeBlock(Directive):
literal = nodes.literal_block(code, code)
literal['language'] = self.arguments[0]
filename = self.options.get('filename')
if filename:
literal['filename'] = filename
caption = self.options.get('caption')
if caption:
literal['caption'] = caption
literal['linenos'] = 'linenos' in self.options or \
'lineno-start' in self.options
extra_args = literal['highlight_args'] = {}
@ -140,7 +140,7 @@ class LiteralInclude(Directive):
'prepend': directives.unchanged_required,
'append': directives.unchanged_required,
'emphasize-lines': directives.unchanged_required,
'filename': directives.unchanged,
'caption': directives.unchanged,
'diff': directives.unchanged_required,
}
@ -269,11 +269,11 @@ class LiteralInclude(Directive):
retnode['language'] = self.options['language']
retnode['linenos'] = 'linenos' in self.options or \
'lineno-start' in self.options
filename = self.options.get('filename')
if filename is not None:
if not filename:
filename = self.arguments[0]
retnode['filename'] = filename
caption = self.options.get('caption')
if caption is not None:
if not caption:
caption = self.arguments[0]
retnode['caption'] = caption
extra_args = retnode['highlight_args'] = {}
if hl_lines is not None:
extra_args['hl_lines'] = hl_lines

2
sphinx/themes/agogo/static/agogo.css_t
View File

@ -467,7 +467,7 @@ div.viewcode-block:target {
border-bottom: 1px solid #ac9;
}
div.code-block-filename {
div.code-block-caption {
background-color: #ddd;
color: #333;
padding: 2px 5px;

6
sphinx/themes/basic/static/basic.css_t
View File

@ -475,7 +475,7 @@ table.highlighttable td {
padding: 0 0.5em 0 0.5em;
}
div.code-block-filename {
div.code-block-caption {
padding: 2px 5px;
font-size: small;
}
@ -484,8 +484,8 @@ div.code-block-filename code {
background-color: transparent;
}
div.code-block-filename + pre,
div.code-block-filename + div.highlight > pre {
div.code-block-caption + pre,
div.code-block-caption + div.highlight > pre {
margin-top: 0;
}

2
sphinx/themes/default/static/default.css_t
View File

@ -309,7 +309,7 @@ div.viewcode-block:target {
border-bottom: 1px solid #ac9;
}
div.code-block-filename {
div.code-block-caption {
color: #efefef;
background-color: #1c4e63;
}

2
sphinx/themes/nature/static/nature.css_t
View File

@ -244,7 +244,7 @@ div.viewcode-block:target {
border-bottom: 1px solid #ac9;
}
div.code-block-filename {
div.code-block-caption {
background-color: #ddd;
color: #222;
border: 1px solid #C6C9CB;

2
sphinx/themes/pyramid/static/pyramid.css_t
View File

@ -341,7 +341,7 @@ code.xref {
font-style: normal;
}
div.code-block-filename {
div.code-block-caption {
background-color: #ddd;
color: #222;
}

2
sphinx/themes/sphinxdoc/static/sphinxdoc.css_t
View File

@ -338,7 +338,7 @@ div.viewcode-block:target {
border-bottom: 1px solid #ac9;
}
div.code-block-filename {
div.code-block-caption {
background-color: #ddd;
color: #222;
border: 1px solid #ccc;

2
sphinx/themes/traditional/static/traditional.css_t
View File

@ -703,6 +703,6 @@ div.viewcode-block:target {
padding: 0 10px;
}
div.code-block-filename {
div.code-block-caption {
background-color: #cceeff;
}

6
sphinx/writers/html.py
View File

@ -283,9 +283,9 @@ class HTMLTranslator(BaseTranslator):
**highlight_args)
starttag = self.starttag(node, 'div', suffix='',
CLASS='highlight-%s' % lang)
if 'filename' in node:
starttag += '<div class="code-block-filename"><code>%s</code></div>' % (
node['filename'],)
if 'caption' in node:
starttag += '<div class="code-block-caption"><code>%s</code></div>' % (
node['caption'],)
self.body.append(starttag + highlighted + '</div>\n')
raise nodes.SkipNode

6
sphinx/writers/latex.py
View File

@ -1345,11 +1345,11 @@ class LaTeXTranslator(nodes.NodeVisitor):
highlight_args['force'] = True
if 'linenos' in node:
linenos = node['linenos']
filename = node.get('filename')
if filename:
caption = node.get('caption')
if caption:
self.body.append('\n{\\colorbox[rgb]{0.9,0.9,0.9}'
'{\\makebox[\\textwidth][l]'
'{\\small\\texttt{%s}}}}\n' % (filename,))
'{\\small\\texttt{%s}}}}\n' % (caption,))
def warner(msg):
self.builder.warn(msg, (self.curfilestack[-1], node.line))
hlcode = self.highlighter.highlight_block(code, lang, warn=warner,

21
tests/roots/test-directive-code/caption.rst Normal file
View File

@ -0,0 +1,21 @@
Dedent
======
Code blocks
-----------
.. code-block:: ruby
:caption: caption-test.rb
def ruby?
false
end
Literal Include
---------------
.. literalinclude:: literal.inc
:language: python
:caption: caption-test.py
:lines: 10-11

1
tests/roots/test-directive-code/index.rst
View File

@ -2,6 +2,7 @@ test-directive-code
===================
.. toctree::
:glob:
*

42
tests/test_directive_code.py
View File

@ -77,6 +77,27 @@ def test_code_block_dedent(app):
assert actual == '\n\n'
@with_app(buildername='html',
srcdir=(test_roots / 'test-directive-code'),
_copy_to_temp=True)
def test_code_block_caption_html(app):
app.builder.build('index')
html = (app.outdir / 'caption.html').text()
caption = '<div class="code-block-caption"><code>caption-test.rb</code></div>'
assert caption in html
@with_app(buildername='latex',
srcdir=(test_roots / 'test-directive-code'),
_copy_to_temp=True)
def test_code_block_caption_latex(app):
app.builder.build('index')
latex = (app.outdir / 'Python.tex').text()
caption = ('{\\colorbox[rgb]{0.9,0.9,0.9}{\\makebox[\\textwidth][l]'
'{\\small\\texttt{caption-test.rb}}}}')
assert caption in latex
@with_app(buildername='xml',
srcdir=(test_roots / 'test-directive-code'),
_copy_to_temp=True)
@ -129,3 +150,24 @@ def test_literal_include_dedent(app):
actual = get_dedent_actual(1000)
assert actual == '\n\n'
@with_app(buildername='html',
srcdir=(test_roots / 'test-directive-code'),
_copy_to_temp=True)
def test_literalinclude_caption_html(app):
app.builder.build('index')
html = (app.outdir / 'caption.html').text()
caption = '<div class="code-block-caption"><code>caption-test.py</code></div>'
assert caption in html
@with_app(buildername='latex',
srcdir=(test_roots / 'test-directive-code'),
_copy_to_temp=True)
def test_literalinclude_caption_latex(app):
app.builder.build('index')
latex = (app.outdir / 'Python.tex').text()
caption = ('{\\colorbox[rgb]{0.9,0.9,0.9}{\\makebox[\\textwidth][l]'
'{\\small\\texttt{caption-test.py}}}}')
assert caption in latex