diff --git a/tests/sample-sets/image/assets/.gitattributes b/tests/sample-sets/image/assets/.gitattributes new file mode 100644 index 00000000..e08b3c97 --- /dev/null +++ b/tests/sample-sets/image/assets/.gitattributes @@ -0,0 +1,2 @@ +*.pdf binary +*.png binary diff --git a/tests/sample-sets/image/assets/confluence.png b/tests/sample-sets/image/assets/confluence.png new file mode 100644 index 00000000..5133a65f Binary files /dev/null and b/tests/sample-sets/image/assets/confluence.png differ diff --git a/tests/sample-sets/image/assets/github.png b/tests/sample-sets/image/assets/github.png new file mode 100644 index 00000000..ea6ff545 Binary files /dev/null and b/tests/sample-sets/image/assets/github.png differ diff --git a/tests/sample-sets/image/assets/logo.svg b/tests/sample-sets/image/assets/logo.svg new file mode 100644 index 00000000..366f52f3 --- /dev/null +++ b/tests/sample-sets/image/assets/logo.svg @@ -0,0 +1,113 @@ + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + diff --git a/tests/sample-sets/image/assets/sphinx.png b/tests/sample-sets/image/assets/sphinx.png new file mode 100644 index 00000000..0a103cd3 Binary files /dev/null and b/tests/sample-sets/image/assets/sphinx.png differ diff --git a/tests/sample-sets/image/conf.py b/tests/sample-sets/image/conf.py new file mode 100644 index 00000000..9097cc7e --- /dev/null +++ b/tests/sample-sets/image/conf.py @@ -0,0 +1,3 @@ +extensions = [ + 'sphinxcontrib.confluencebuilder', +] diff --git a/tests/sample-sets/image/index.rst b/tests/sample-sets/image/index.rst new file mode 100644 index 00000000..47606f63 --- /dev/null +++ b/tests/sample-sets/image/index.rst @@ -0,0 +1,190 @@ +image +===== + +.. _output_section: + +Image directive +^^^^^^^^^^^^^^^ + +.. image:: assets/sphinx.png + :align: right + :width: 300px + +The `image directive`_ can be used to add images into a document. Images from +the local documentation directory can be used, as well as embedded images (via +the data uri schema) or even externally referenced images. This extension takes +advantage of image formatting capabilities in Confluence. This page should +render an image floating in the top-right of the page. Adding a paragraph to +help visualize the floating image element. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris in gravida dui, +at finibus sem. Donec at convallis purus, quis pellentesque dolor. Praesent +sollicitudin eleifend diam, nec iaculis ante semper eu. Cras luctus dolor +malesuada, vulputate augue tristique, sodales dolor. Fusce vehicula ipsum urna, +vel ultricies purus tristique non. Nunc placerat ipsum sit amet molestie +efficitur. Etiam at euismod lectus. Mauris posuere tortor vitae arcu rhoncus, eu +dapibus ipsum imperdiet. Donec libero metus, interdum quis pretium eu, mattis a +magna. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere +cubilia Curae; Pellentesque condimentum finibus elit, eu tincidunt urna faucibus +ut. Phasellus vehicula aliquam dolor vel sodales. + +Images are typically included inline as follows: + +.. raw:: confluence_storage + +

+ +.. image:: assets/confluence.png + :align: center + :alt: alternate text + +.. raw:: confluence_storage + +

+ +Embedded images should be translated by Sphinx and this extension should handle +these images as well. One of these images is embedded and also one of these +images links to a target: + +.. raw:: confluence_storage + +

+ +.. image:: assets/github.png + +.. image:: + data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHgAAAB4CAYAAAA5ZDbSAAAAGXRFWH + RTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAA + AAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+ID + x4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3 + JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZj + pSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbn + MjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYW + RvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS + 4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZX + NvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3 + NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFNTE3OEEzMjk5QTAxMUUyOUExNUJDMTA0Nk + E4OTA0RCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoyQTQxNEFCQzk5QTExMUUyOUExNUJDMT + A0NkE4OTA0RCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOk + U1MTc4QTMwOTlBMDExRTI5QTE1QkMxMDQ2QTg5MDREIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZG + lkOkU1MTc4QTMxOTlBMDExRTI5QTE1QkMxMDQ2QTg5MDREIi8+IDwvcmRmOkRlc2NyaXB0aW9uPi + A8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+R7ClIwAADR5JREFUeN + rsnQuwVWUVx79zeWUXNWB4RIhXCCNUVLiCQJoBlqCIYaIBUpRGltMICE6JxojSjIKlhTmkgmjkoC + lqcBkTHeSNIAooQkTIw3gooAKCXL39/+x1bvtezjl373P22nufc741s2ZzmXu/x/rt/T3Xt75EVV + WVsVK4kiiESrRs3qI1Hp2hX4e2g5ZBW0GbiTaGNqr1Z0ehB6Efiu6CboVugW6Grt29d8/7FnD4ML + +MRw9oL9FyaFOl7PZBV0GXiC4D9MMWcPBQ2+IxCNoP+u0UX2NYwq9+IbQC+hxgv2cBZw+1BR5Dod + dCu8e0mCugs6FPAvYeC9gb2D54jIReBW2QJy3hMejz0IcBeoEFfCLU+nhcBx0rg6V8lrXQ+6BPAX + ZlUQMWsMOg46HtC2yG8m/o3dJ8VxYdYMC9HI/J0I4FPhXdCB0DyHOLAjDAnonHA9DLimzNYT70Fo + DeWJCAAbaB9LF3RjjNiVo4zbqLfTRAHysYwIDbCY9Z0HONFcpb0CGA/E5eAwZYpv8L6Wu/ZLnWkC + PSok0F6Kq8Awy4XP99DHqNZZlRnoGOAOSDeQMYcDvgMQfayfLzJBugAwH5X7EHDLjfMs6qTlPLzZ + fsE8iLg0y0JGC4g/FYYOFmJbTZArFhYFIvQLgj8JgJrW9Z5cTj6salpTsOHT60JjaAAfcmPKaZAn + EgiFhow4GAvAeQV0UOWL7caZZL4HI5IG/P9UuulyPcwdIs2y9XRwYA8ruA/Hboo2gZLXNA1dByUJ + XPoH2yHV0nsoTLee5yO1oOdQp1YTbz5EQWcLlCtRL6TWv3UIWLId38rniV+ITLF2K6hRuJ0ObThY + HOIAsd/s143JpjQQ9AOWigLzK3DQt9E4L1ZdO6A1qaY3259PsBBl0rA2+iZcvvDZP7Xu4Vbu8GpN + uGgwjjOAAMhJ6U50A/Nc5SLTf4F6CuO1x1HYDHCzmmzz3lrkj37cAAy2b96yb3/VwOFlql2+xGPq + cYx0eLXpX55ny3DvqwcXywPs5gx93QJjnmxf3kC7w4DXjtg8eZYDbrKzIVioaBPgRlXnRyX5EHYN + lc9kOZO0vZP85QP9a9IoA8aZ/bAhlk4a37Bh53BGSM17z+IozBJo5HVK42znmhuAnL9AOZvsz38X + eLAsp/vLDJKF42Bh40wflQ+VpbFU+HZ1GRuTK4uyNDWd6Twdu70J3Q90U5mDskfeNR+d1G0tdz0M + PDaa1Fv2YcL8+zoKdn6AMnQe9F+Y5kYYPXA7JlI2Hzvaz7YHFt/UdABWLzVJqLs5kssDwKPRu6VF + oEfhHrgvaIkPn+OVCu2F1snINufIFuyMUzUvphvnBBndq4IpNLbiJDQepLhc4MqCDbUJDTAzA8y5 + xAWl+E2R4j3xJpVb4IIK3teLQJqGicgnVK51yfqYkeFiBcyq4gEpFmO/RT6wG/UP8NEHAHYTXD8y + BLmpHxCvNDK44EfcaYA66GfkbRPAjW3nLIGyGra/0AvlWhENYv+v+isVo31hNgfOp9jc4q0umWa7 + W0VUjzHGFX5xf8c62BKApwcrGTFRu0VEr+poyAJWzClUqZc3rTxX68x22g5eI0QBim/YKHGd2wCX + 0tX1UbNBCGaQEPVq7cAMtX3QaDUwLGp80AYtrRbO62fNVt0B0s26f6gq9Sznji7r17nil2umKDu5 + SzGZgKcD/FDJeHUKl8koliEy3p7x7ZJsMD0ttCI7TC55yj4c3dYLnWmLFwW5JeIBpnubil2ZRhF5 + NfcC+jFzdjqoWbsqnmvvVUpeQbCdPqJrqnUkbcEL/H4kwrk8RGGtLTDbiXUiZPxDWGY0y+YtrmCa + Xka3zBXZUyecRijMxGx5km0NnTD2mHQgZb8IbaLUdvAy6GPWynkHQbfsFa/sfzLDrPUqGUbmcC7q + CU+GLLLXJbdSDgMqXEV1pukduqTAswXWO3WW6ehbaq1ALcSiHh7RhgfW65eZ4uEe5OhaRbEXAzhY + Q/sdh8ywGFNJtpAf7I8vItB7UAa/hJ1bO8fIvGpsPJBKwRJaex5eVbNNyKG5YoFbbU8vItp2gkqg + XYxs6Kic20ALfyGw2mmEVOLrbQAlyp9Da2tug8C22l4a5cWaI4pTnDcvMs7ZTS/ahEaYKtWehCFK + 2P4QAB71VKvNxy8ywXKKW7l4B3KiXe03KL3FY7NQGfJ+64VjKPoLlm0FkT8GalxLlc2dsirFN6G7 + 2l3c0EvEmx8IMsvzrl+4ppb0pIMNDtShlw25CxKQ9bjimbZ3ZhjD6kdTD+tBKJhvqhUgYs+FCLMq + 0MVYS7j2yTS5WrFSsxOhlEzEqNr5fbg6MVszgeNjJp+KWKGfGQ1Y8s0hPkeqN7+/kyN+AlypWZJL + GgrZjquNiTlLNZ7AbMH44qZkbHvvst2mr5g9FxdkzK0RqAJSzuIuVK/RRv7hD79bZgkJQRytksSo + Y6dg9+Xgyhfo+ggj2KGC5P/IVxDWB1CGg34OdDyJgh/Oajot2LEC7rPM+Ec+nInBMA45NmxPQwjp + twgPESKvzdIoLL+Cf/NEp+V7VkpbA84Qum/DWkOrOiFaj4BGi9AgZbD8qwSXMVFzRqyyz3D7UB/8 + 0454rCEOb9W+hCGOHcAoTbRaaft5vwbmc9JgxTA8anvdfdfockHHishkH+BG1bAGDPgP7FOCtJYY + 815tQOmZFIUcBL8HjV54oJR21MmNECuHnNLbD6Wb6B7Cb+jIKuzCOotONFxonUy1CCUXU7vWG3Vz + MClgLzCrvzPSTI20NOrX2SEH/fHI9R0DEme39fhl56Sl6eNXJXQ6z6V+Pc68SgY4yQH7WT4Vuw0X + m1/zORYTLuNfrLb5Dw72r9/SJZSZkpX+T5ORae18G9Jq0F7x1ajzwPhAyU26q8zqdcWinC/UqM3r + nrYZMnvQJm88pAXV6DqDwAvQ0ZHHXN+RhprUJcUmYbV3i9gITbnAxewuvvfh30NTtyMcmD0o/SQ/ + TUGPcStEPHVFfrZLo3iTtAM3xkwhdiCDJZ40qD3gq3SBPG5vbigCvGLuIid54BQ+4qI+FGJt4yAj + aYkW6qkk7YRK/zkQm3vpbAKO6r1ugOxGtp2TcMMsGHaxqjBVdmFdwnHxdzuOulK0wpdV1txxUYv+ + GQeD9SXxhnaYr0+sukP5BBBbSL9g1oMpjiix7XW8/7syvMtNiQ6Q2uMP7vLuRa69/ddwewH4ZyqY + 59xOMBVey+MK63kxnCvTGFOy8T3DoBi7AP9btXzL1Od4g+TnHYn02U9DbmWDE68z0boiEZxPtIzO + CSya/q+qUSD28wR2h3ZlGAAdIkG/Gq5IrVOJne8N6CXBzuX0E6oV2VJzebvhIzwBOEjcn1C6bQG2 + NVFoWY4rq1cwN0oUybOJfk1bXvZFm5pREYNE6R+zj4m+zlF0s8vsHsO4cZ/xdMdjQn3jLC+3i54/ + FH4xy6mgL9zEeaHJm/FIFR4xLUnAyGpbtONtsv2MilyKOymcrU+vll6Z8/ZdMN5T2JXOa7XeactZ + 3kPzCOOxH77wtlQv9mBIbdGhPAoyRavCfxvY2FJpbLYX6d2XuiUMvSpEe402ShZCx9ifB/TYyzf7 + ofP38iv1cuCyYvsqkP26rIvwyP/0QMdxbq7sv22Tikj4Su9fk392fY2OdLxrXqm6Fnyf/xanVueK + wQ2EZeArYGN0Zk3IMRw10ntjeqgPEGcXmQ9xv6OTjOpnVCmvS24HGacc4wrXb1M9vki0lO0XgX0G + XQn0Rk4MoI4bKbulJG874ka08D8Y5cYPw5kf0ShXzI5KGgvtw52h/RoCrlyqBWE5388pZJn+hnNW + kqDDVZdmryTaIoM207JFu4OQEWyC/gMdwnZPajbwDypXkGuDQCuMNh45xcqAJxBpOtxceyeGHolj + PdOL5Euzzm9VU89oQdjzrkUTThjkQdc76RJRGgATh8n5lDq8Blt/Uy3zwg82GWj+GOuXFRJqPrpt + AmEXh0hAU4+eUG4sIcWAhbFghGYFC12SY77/32xrsHSdw34HMZUF0nXV8gEujBbBSMW4vfMY6Hpa + acVIBwabM+QcINHLBApo9UN+ibxopX4cJRt3SrfbECLJB5NoabCo9bdnUKXaN6us8TxR6wQD4E/T + H+eYNxnOOs1BTa5EbYaLisDpq8AuwC/ahxnO5WWKbVQlt0CWIaFDlggcxoevToGG387ykX2iiZ26 + O9YJNNYWQYWngjLkxAf28c78TnihAu69wJNpgS5iJN6PGrOJiA0ke6j3G2BAtd6Ld9KesM3Rp25p + EFKENl6cTGTfwfGv/uMPkQkmmD1K0cdX05qkJEGoGOJwahPNLCQ108drnc45/ui6C4Xl2HV0hdzm + bdwvDdziSxuxmlZfMWdA5InrNNtWK1GkYrj6hs9Cztmgb+08Y517w0TvaM7dU3ssF+jXH8v3pIWX + m4+WdaiwIeylSGB0/vX2KcTQG2ONwUeBpl2h9HOyaqqqqMlcIVGwW2wOV/AgwA+MQnGo+UarEAAA + AASUVORK5CYII= + +.. image:: assets/github.png + :target: `output_section`_ + +.. raw:: confluence_storage + +

+ +The following is an example of an SVG image: + +.. image:: assets/logo.svg + :align: center + +The following is an example of an image found on an external server (with a +link target): + +.. image:: https://img.shields.io/pypi/v/sphinxcontrib-confluencebuilder.svg + :target: https://pypi.python.org/pypi/sphinxcontrib-confluencebuilder + :alt: pip Version + :align: center + +Figure directive +^^^^^^^^^^^^^^^^ + +The `figure directive`_ can be used to add images with captures and legend data +into a document. + +.. figure:: assets/confluence.png + :alt: Confluence Logo + :align: left + + This is the caption of the figure (a simple paragraph). + + The legend consists of all elements *after* the caption. + +Another figure but with a centered image and centered caption: + +.. figure:: assets/confluence.png + :alt: Confluence Logo + :align: center + + This is the caption of the figure. + +Another figure but with a right-aligned image: + +.. figure:: assets/confluence.png + :alt: Confluence Logo + :align: right + :width: 100px + + This is the caption of the figure. + +Another figure but scaled down: + +.. figure:: assets/confluence.png + :alt: Confluence Logo + :scale: 50% + + This is the caption of the figure. diff --git a/tests/sample-sets/image/tox.ini b/tests/sample-sets/image/tox.ini new file mode 100644 index 00000000..c2ccb2cd --- /dev/null +++ b/tests/sample-sets/image/tox.ini @@ -0,0 +1,11 @@ +[tox] +package_root={toxinidir}{/}..{/}..{/}.. + +[testenv] +commands = + {envpython} -m tests.test_sample {posargs} +setenv = + PYTHONDONTWRITEBYTECODE=1 + TOX_INI_DIR={toxinidir} +passenv = * +use_develop = true