def setup(app):
add_image_type(app, 'visio', ('vsd', 'vsdx'), VisioConverter)
add_image_directive(app, 'visio', VisioConverter.option_spec)
add_figure_directive(app, 'visio', VisioConverter.option_spec)
return {
'version': pkg_resources.require('sphinxcontrib-visio')[0].version,
'parallel_read_safe': True,
'parallel_write_safe': True,
}
def setup(app):
add_image_type(app, 'visio', ('vsd', 'vsdx'), VisioConverter)
add_image_directive(app, 'visio', VisioConverter.option_spec)
add_figure_directive(app, 'visio', VisioConverter.option_spec)
return {
'version': pkg_resources.require('sphinxcontrib-visio')[0].version,
'parallel_read_safe': True,
'parallel_write_safe': True,
}
def test_add_image_directive(self, app, status, warnings):
"""
.. foo-image:: contents.rst
"""
add_image_directive(app, 'foo')
with self.assertRaises(NotImplementedError): # will raise error on writer
app.build()
with open(app.builddir / 'doctrees' / app.config.master_doc + '.doctree', 'rb') as fd:
doctree = pickle.load(fd)
self.assertIsInstance(doctree[0], image_node)
self.assertEqual(doctree[0]['uri'], 'contents.rst')
def test_add_image_directive_in_subdir(self, app, status, warnings):
(app.srcdir / 'contents.rst').write_text('')
(app.srcdir / 'subdir').makedirs()
(app.srcdir / 'subdir' / 'contents.rst').write_text('.. foo-image:: filename.rst')
(app.srcdir / 'subdir' / 'filename.rst').write_text('')
add_image_directive(app, 'foo')
with self.assertRaises(NotImplementedError): # will raise error on writer
app.build()
with open(app.builddir / 'doctrees' / 'subdir' / 'contents.doctree', 'rb') as fd:
doctree = pickle.load(fd)
self.assertIsInstance(doctree[0], image_node)
self.assertEqual(doctree[0]['uri'], 'subdir/filename.rst')
def test_add_image_directive_with_name_option(self, app, status, warnings):
"""
.. foo-image:: contents.rst
:name: target
"""
add_image_directive(app, 'foo')
with self.assertRaises(NotImplementedError): # will raise error on writer
app.build()
with open(app.builddir / 'doctrees' / 'contents.doctree', 'rb') as fd:
doctree = pickle.load(fd)
self.assertIsInstance(doctree[0], image_node)
self.assertEqual(doctree[0]['uri'], 'contents.rst')
self.assertEqual(doctree[0]['names'], ['target'])
def test_add_image_directive_for_http(self, app, status, warnings):
"""
.. foo-image:: http://example.com/
"""
(app.srcdir / 'subdir').makedirs()
(app.srcdir / 'subdir' / 'contents.rst').write_text('')
add_image_directive(app, 'foo')
with self.assertRaises(NotImplementedError): # will raise error on writer
app.build()
with open(app.builddir / 'doctrees' / app.config.master_doc + '.doctree', 'rb') as fd:
doctree = pickle.load(fd)
self.assertIsInstance(doctree[0], image_node)
self.assertEqual(doctree[0]['uri'], 'http://example.com/')
def test_add_image_directive_with_option_spec(self, app, status, warnings):
"""
.. foo-image:: contents.rst
:bar: 255
"""
option_spec = {'bar': directives.positive_int}
add_image_directive(app, 'foo', option_spec)
with self.assertRaises(NotImplementedError): # will raise error on writer
app.build()
with open(app.builddir / 'doctrees' / 'contents.doctree', 'rb') as fd:
doctree = pickle.load(fd)
self.assertIsInstance(doctree[0], image_node)
self.assertEqual(doctree[0]['uri'], 'contents.rst')
self.assertEqual(doctree[0]['bar'], 255)
def test_add_image_directive(self, app, status, warnings):
"""
.. foo-image:: contents.rst
"""
add_image_directive(app, 'foo')
with self.assertRaises(
NotImplementedError): # will raise error on writer
app.build()
with open(
app.builddir / 'doctrees' / app.config.master_doc + '.doctree',
'rb') as fd:
doctree = pickle.load(fd)
self.assertIsInstance(doctree[0], image_node)
self.assertEqual(doctree[0]['uri'], 'contents.rst')
def test_add_image_directive_with_name_option(self, app, status, warnings):
"""
.. foo-image:: contents.rst
:name: target
"""
add_image_directive(app, 'foo')
with self.assertRaises(
NotImplementedError): # will raise error on writer
app.build()
with open(app.builddir / 'doctrees' / 'contents.doctree', 'rb') as fd:
doctree = pickle.load(fd)
self.assertIsInstance(doctree[0], image_node)
self.assertEqual(doctree[0]['uri'], 'contents.rst')
self.assertEqual(doctree[0]['names'], ['target'])
def test_add_image_directive_in_subdir(self, app, status, warnings):
(app.srcdir / 'contents.rst').write_text('')
(app.srcdir / 'subdir').makedirs()
(app.srcdir / 'subdir' /
'contents.rst').write_text('.. foo-image:: filename.rst')
(app.srcdir / 'subdir' / 'filename.rst').write_text('')
add_image_directive(app, 'foo')
with self.assertRaises(
NotImplementedError): # will raise error on writer
app.build()
with open(app.builddir / 'doctrees' / 'subdir' / 'contents.doctree',
'rb') as fd:
doctree = pickle.load(fd)
self.assertIsInstance(doctree[0], image_node)
self.assertEqual(doctree[0]['uri'], 'subdir/filename.rst')
def test_add_image_directive_with_option_spec(self, app, status, warnings):
"""
.. foo-image:: contents.rst
:bar: 255
"""
option_spec = {'bar': directives.positive_int}
add_image_directive(app, 'foo', option_spec)
with self.assertRaises(
NotImplementedError): # will raise error on writer
app.build()
with open(app.builddir / 'doctrees' / 'contents.doctree', 'rb') as fd:
doctree = pickle.load(fd)
self.assertIsInstance(doctree[0], image_node)
self.assertEqual(doctree[0]['uri'], 'contents.rst')
self.assertEqual(doctree[0]['bar'], 255)
def test_add_image_directive_for_http(self, app, status, warnings):
"""
.. foo-image:: http://example.com/
"""
(app.srcdir / 'subdir').makedirs()
(app.srcdir / 'subdir' / 'contents.rst').write_text('')
add_image_directive(app, 'foo')
with self.assertRaises(
NotImplementedError): # will raise error on writer
app.build()
with open(
app.builddir / 'doctrees' / app.config.master_doc + '.doctree',
'rb') as fd:
doctree = pickle.load(fd)
self.assertIsInstance(doctree[0], image_node)
self.assertEqual(doctree[0]['uri'], 'http://example.com/')
def setup(app):
add_image_type(app, 'cacoo', 'https://cacoo.com/', CacooConverter)
add_image_directive(app, 'cacoo')
add_figure_directive(app, 'cacoo')
app.add_config_value('cacoo_apikey', None, 'html')
def setup(app):
add_image_type(app, 'cacoo', 'https://cacoo.com/', CacooConverter)
add_image_directive(app, 'cacoo')
add_figure_directive(app, 'cacoo')
app.add_config_value('cacoo_apikey', None, 'html')
