RE: A tool to add diagrams to sphinx docs

Path	csiph.com!fu-berlin.de!uni-berlin.de!not-for-mail
From	Albert-Jan Roskam <sjeik_appie@hotmail.com>
Newsgroups	comp.lang.python
Subject	RE: A tool to add diagrams to sphinx docs
Date	Fri, 1 Apr 2016 19:14:32 +0000
Lines	21
Message-ID	<mailman.323.1459538140.28225.python-list@python.org> (permalink)
References	<56fea147$0$5832$e4fe514c@news.xs4all.nl>
Mime-Version	1.0
Content-Type	text/plain; charset="windows-1256"
Content-Transfer-Encoding	base64
X-Trace	news.uni-berlin.de ZFQ3Wuli6ikBcLf/+7cgDgpbG0Mxic9KWHuot84G8jeQ==
Return-Path	<sjeik_appie@hotmail.com>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
X-Spam-Status	OK 0.019
X-Spam-Evidence	'H': 0.96; 'S': 0.00; 'resulting': 0.04; 'dependency': 0.07; 'sphinx': 0.07; 'docs.': 0.09; 'instead.': 0.15; '.rst': 0.16; '2016': 0.16; 'directive': 0.16; 'received:io': 0.16; 'received:psf.io': 0.16; 'wrote:': 0.16; 'looked': 0.16; '>': 0.18; '+0200': 0.20; 'to:name:python- list@python.org': 0.20; 'to:2**1': 0.21; 'file.': 0.22; "haven't": 0.24; 'tried': 0.24; 'header:In-Reply-To:1': 0.24; "i've": 0.25; 'fri,': 0.27; 'guess': 0.31; 'date:': 0.31; 'option': 0.31; 'included': 0.32; 'html,': 0.33; 'editor': 0.34; 'file': 0.34; 'add': 0.34; 'saved': 0.35; 'subject:': 0.35; 'but': 0.36; 'too': 0.36; 'should': 0.36; 'tool': 0.36; 'email addr:python.org': 0.36; 'to:addr:python-list': 0.36; 'subject:: ': 0.37; 'display': 0.37; 'format': 0.39; 'from:': 0.39; 'to:addr:python.org': 0.40; 'skip:u 10': 0.61; 'federal': 0.62; 'email name:python-list': 0.67; 'charset:windows-1256': 0.67; '100%': 0.72; 'subject:tool': 0.84; 'quality.': 0.91; 'subject:add': 0.91; 'trojan': 0.91
X-TMN	[hwhH/Eqnss7M//36BQeNksvfLQtolaRN]
X-Originating-Email	[sjeik_appie@hotmail.com]
Importance	Normal
In-Reply-To	<56fea147$0$5832$e4fe514c@news.xs4all.nl>
X-OriginalArrivalTime	01 Apr 2016 19:14:32.0338 (UTC) FILETIME=[B89F6F20:01D18C4A]
X-Content-Filtered-By	Mailman/MimeDel 2.1.21
X-BeenThere	python-list@python.org
X-Mailman-Version	2.1.21
Precedence	list
List-Id	General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe	<https://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive	<http://mail.python.org/pipermail/python-list/>
List-Post	<mailto:python-list@python.org>
List-Help	<mailto:python-list-request@python.org?subject=help>
List-Subscribe	<https://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Xref	csiph.com comp.lang.python:106247

Show key headers only | View raw


> Subject: Re: A tool to add diagrams to sphinx docs
> From: irmen.NOSPAM@xs4all.nl
> Date: Fri, 1 Apr 2016 18:26:48 +0200
> To: python-list@python.org
> 
> On 1-4-2016 17:59, George Trojan - NOAA Federal wrote:
> > What graphics editor would you recommend to create diagrams that can be
> > included in sphinx made documentation? In the past I used xfig, but was not
> > happy with font quality. My understanding is the diagrams would be saved in
> > a .png file and I should use an image directive in the relevant .rst file.
> > 
> > George
> > 
> 
> I've used .png successfully for a few images in my sphinx docs.
> However if you're concerned with font quality, a better option is perhaps to use a
> vector format like SVG instead. You can create them using a tool like Inkskape or
> Illustrator. I haven't tried to use .svg in sphinx myself yet but I guess it simply
> embeds/links it into the resulting html so a recent web browser should display them just
> fine.
I used .svg for dependency graphs made with snakefood. Looked good in html, though they essily get too detailed. The .rst:

.. figure:: images/my_image.svg    :width: 100%

Back to comp.lang.python | Previous | Next — Previous in thread | Find similar | Unroll thread

Thread

A tool to add diagrams to sphinx docs George Trojan - NOAA Federal <george.trojan@noaa.gov> - 2016-04-01 15:59 +0000
  Re: A tool to add diagrams to sphinx docs Irmen de Jong <irmen.NOSPAM@xs4all.nl> - 2016-04-01 18:26 +0200
    RE: A tool to add diagrams to sphinx docs Albert-Jan Roskam <sjeik_appie@hotmail.com> - 2016-04-01 19:14 +0000

csiph-web