svglib icon indicating copy to clipboard operation
svglib copied to clipboard

Add some decent documentation to go on readthedocs.org, too

Open deeplook opened this issue 7 years ago • 5 comments

Content to be fleshed out in this ticket first, and then in the Wiki, later...

deeplook avatar Apr 11 '18 21:04 deeplook

Is there any documentation whatsoever yet? I couldn't find out what api is available or how it interacts with a canvas, if it's possible to use svglib to concatenate svgs in one pdf.

Luvideria avatar Sep 07 '20 07:09 Luvideria

Sadly, there isn't. I'd surely like to see it happen, but there is maybe not so much to document, after all? Most people will likely use the command-line tool or a single function to use svglib programmatically. But, yes, some Sphinx pages would be nice, some notebooks, too...

deeplook avatar Sep 08 '20 13:09 deeplook

For the documentations, MkDocs-Material can generate beautiful ones like https://pawamoy.github.io/aria2p/

I'm pretty familiar with it as I made the website of Inventory-Profiles, so I could eventually make the website, if you want to use MkDocs-Material of course

marie-bnl avatar Aug 26 '21 18:08 marie-bnl

I'd actually prefer some simple vanilla Sphinx thingy, maybe with https://github.com/executablebooks/sphinx-thebe for running examples online in mybinder.org.

deeplook avatar Aug 27 '21 10:08 deeplook

You could do that in MkDocs Material too! But I understand you prefer Sphinx theme 👍

marie-bnl avatar Aug 27 '21 11:08 marie-bnl