Xanadu Sphinx Theme

Usage

API

  1. Docs
  2. Module code
  3. xanadu_sphinx_theme
  4. xanadu_sphinx_theme.directives.gallery_item

Source code for xanadu_sphinx_theme.directives.gallery_item

"""
This module implements the ``gallery-item`` reST directive.

Derived from https://github.com/pytorch/tutorials/blob/master/custom_directives.py
which carries the following license:

BSD 3-Clause License

Copyright (c) 2017, Pytorch contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""

import os
from inspect import cleandoc
from pathlib import Path
from shutil import copyfile

from docutils import nodes
from docutils.parsers.rst import Directive, directives
from docutils.statemachine import StringList
from sphinx_gallery.gen_rst import scale_image

OPEN_TEMPLATE = '<div class="gallery-item-thumbcontainer col-auto" {attributes}>'
CLOSE_TEMPLATE = "</div>"

FIGURE_TEMPLATE = cleandoc(
    """
    .. figure:: {thumbnail}

        {description}
    """
)



[docs]class GalleryItemDirective(Directive):
    """Creates a sphinx-gallery-style thumbnail.

    Note that the ``description`` option can be a link to a document. Also,
    thumbnails will be created out of figures and stored in ``/_static/thumbs``.
    Therefore, consider ``/_static/thumbs`` as a "built" directory.

    **Example**

    .. gallery-item::
        :tooltip: Get started
        :figure: _static/teleport.png
        :description: :doc:`/started`

    .. raw:: html

        <div style="clear:both;">
    """

    required_arguments = 0
    optional_arguments = 0
    final_argument_whitespace = True
    option_spec = {
        "description": directives.unchanged_required,
        "figure": directives.unchanged_required,
        "tags": directives.unchanged,
        "tooltip": directives.unchanged,
    }

    has_content = False
    add_index = False


[docs]    def run(self):
        path_to_root = Path(".").resolve()
        path_to_thumbs = path_to_root / "_static/thumbs"
        path_to_figure = path_to_root / self.options["figure"]
        path_to_thumbnail = path_to_thumbs / path_to_figure.name

        os.makedirs(str(path_to_thumbs), exist_ok=True)

        if path_to_figure.suffix == ".svg":
            copyfile(str(path_to_figure), str(path_to_thumbnail))
        else:
            scale_image(str(path_to_figure), str(path_to_thumbnail), 400, 280)

        thumbnail = "/" + str(path_to_thumbnail.relative_to(path_to_root))

        attributes_dict = {}
        if "tags" in self.options:
            attributes_dict["data-category"] = self.options["tags"]
        if "tooltip" in self.options:
            attributes_dict["tooltip"] = self.options["tooltip"][:195]

        attributes_list = [f"{k}='{v}'" for k, v in attributes_dict.items()]
        attributes_html = " ".join(attributes_list)

        figure_rst = FIGURE_TEMPLATE.format(
            description=self.options["description"],
            thumbnail=thumbnail,
        )
        figure_list = StringList(figure_rst.split("\n"))
        figure_node = nodes.container()
        self.state.nested_parse(figure_list, self.content_offset, figure_node)

        open_div = nodes.raw(text=OPEN_TEMPLATE.format(attributes=attributes_html), format="html")
        close_div = nodes.raw(text=CLOSE_TEMPLATE, format="html")
        return [open_div, *figure_node.children, close_div]