Open stichbury opened 1 year ago
The plugin might be this one https://github.com/sphinx-contrib/images
@stichbury I would like to try working on this issue using the plugin
The plugin might be this one https://github.com/sphinx-contrib/images
@Gundalai-Batkhuu https://github.com/kedro-org/kedro/issues/2287#issuecomment-1772379988
@astrojuanlu It looks like to use this plugin, the source docs need to have .rst extension. In example, the inline reference of the large image mentioned above should become:
.. thumbnail:: docs/source/meta/images/pipeline_visualisation_with_layers.png
from:
"../meta/images/pipeline_visualisation.png"
If we do that, we can make thumbnails and adjust the size of the photos. What do you think?
We will not change the docs to rst - but the good news is that you can evaluate rst inside myst
```{eval-rst}
.. figure:: img/fun-fish.png
:width: 100px
:name: rst-fun-fish
Party time!
A reference from inside: :ref:`rst-fun-fish`
A reference from outside: :ref:`syntax/directives/parsing`
@astrojuanlu Thanks for the help. It worked. I've made the following changes:
Now the images look like this:
I have the following questions:
Let's start with a PR of what you already have @Gundalai-Batkhuu , and we can discuss about extending it to other parts of the code
For future reference, in #3238 we found that https://pypi.org/project/sphinxcontrib-images/ has a bug when rendering the thumbnails on mobile. alternative solutions (or a fix upstream) are needed.
Introduction
in PR #2625 I posted this response on taking a look through the diagrams in our docs: