sphinx Lightbox extension and Markdown

38 views
Skip to first unread message

StefanK

unread,
Jan 27, 2020, 4:35:56 PM1/27/20
to sphinx-users
Hi,

working on a documentation project. 
We use gitlab and gitlab wiki. Love the feature to just copy and paste snapshotted pictures into gitlab wiki. 

Creating sphinx docu works fine. Only using .rst for index file. 

Installed sphinxcontrib.images and added some basic options into conf.py. 

No lightbox features for my markdown files :( 

For testing I added a .rst file and put it into the toctree. 

.. image:: _static/images/sphinx-quickstart.png

Lightbox worked with it. 

So I'm not that sure what is the reason here. 
Markdown?

Markdown images (via C'n'P) look like this: 
![image](uploads/a9049fff2f44191479cd0dea5960511e/image.png)


How can I get lightbox feature for my markdown files?
I could try to convert all markdown files to .rst first. But not sure - there where some problems with markdown subfolders before. 
Fixed them with simple cp in gitlab. 








Komiya Takeshi

unread,
Jan 29, 2020, 11:58:23 AM1/29/20
to sphinx...@googlegroups.com
Hi,

It seems sphinxcontrib-images extends "image" directive of Sphinx. But
recommonmark does not use and embed images directly to document-tree.
So it would not work. I don't have idea they work together...

Thanks,
Takeshi KOMIYA

2020年1月28日(火) 6:36 StefanK <itaros.g...@gmail.com>:
> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/dac6dc6e-ac77-4637-9e18-ccfe12dfd937%40googlegroups.com.

StefanK

unread,
Jan 29, 2020, 1:58:52 PM1/29/20
to sphinx-users
Hi,

found a solution! 

Installed m2r and converted .md to rst. 

.. image:: uploads/c10162322847cfeefdfbad3f966d4358/image.png
   :target: uploads/c10162322847cfeefdfbad3f966d4358/image.png
   :alt: image

Doesn't work because of :target: if I remove that line - it works :)

No python guy, though. But the code is here: https://github.com/miyakogi/m2r 
I just have to remove the line with the target.

There's a bunch of other stuff that doesn't work in markdown via sphinx - like markdown todos. Or gitlab markdown mermaid.
Will probably create a issue there - but now I can live with my quickfix. 


 








Am Mittwoch, 29. Januar 2020 17:58:23 UTC+1 schrieb Komiya Takeshi:
Hi,

It seems sphinxcontrib-images extends "image" directive of Sphinx. But
recommonmark does not use and embed images directly to document-tree.
So it would not work. I don't have idea they work together...

Thanks,
Takeshi KOMIYA

2020年1月28日(火) 6:36 StefanK <itaros....@gmail.com>:
>
> Hi,
>
> working on a documentation project.
> We use gitlab and gitlab wiki. Love the feature to just copy and paste snapshotted pictures into gitlab wiki.
>
> Creating sphinx docu works fine. Only using .rst for index file.
>
> Installed sphinxcontrib.images and added some basic options into conf.py.
>
> No lightbox features for my markdown files :(
>
> For testing I added a .rst file and put it into the toctree.
>
> .. image:: _static/images/sphinx-quickstart.png
>
>
> Lightbox worked with it.
>
>
> So I'm not that sure what is the reason here.
>
> Markdown?
>
>
> Markdown images (via C'n'P) look like this:
>
> ![image](uploads/a9049fff2f44191479cd0dea5960511e/image.png)
>
>
>
> How can I get lightbox feature for my markdown files?
>
> I could try to convert all markdown files to .rst first. But not sure - there where some problems with markdown subfolders before.
>
> Fixed them with simple cp in gitlab.
>
>
>
>
>
>
>
>
>
> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx...@googlegroups.com.
Reply all
Reply to author
Forward
0 new messages