linux-wireless.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Johannes Berg <johannes@sipsolutions.net>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-wireless@vger.kernel.org, linux-doc <linux-doc@vger.kernel.org>
Subject: Re: sequence diagrams in rst documentation
Date: Fri, 21 Oct 2016 14:31:39 +0200	[thread overview]
Message-ID: <1477053099.4068.42.camel@sipsolutions.net> (raw)
In-Reply-To: <1476863488.5927.10.camel@sipsolutions.net>


> > 	https://pythonhosted.org/sphinxcontrib-aafig/
> > 
> > I've not actually played with it at all, but I like the idea that
> > we'd have readable diagrams in the source docs as well...
> 
> Well, maybe. I agree having it readable in the source docs as well is
> nice, but for sequence diagrams in particular, I don't think
> 
>     +-------+         +-----------+
>     | Hello +-------->+ aafigure! |
>     +-------+         +-----------+
> 
> really beats
> 
>    Hello -> aafigure!


I found another one:

https://pypi.python.org/pypi/sphinxcontrib-plantuml

That one has really nice output and features, but ends up being a
*java* (of all the things) tool that the thing calls out to ...


Perhaps we can have a compromise and embed the raw text when the
tooling isn't all installed, so you can still build useful
documentation, but to get all the "prettiness" you might have to
install more dependencies?

johannes

  reply	other threads:[~2016-10-21 12:31 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-11 12:56 [PATCH] docs-rst: sphinxify 802.11 documentation Johannes Berg
2016-10-11 13:21 ` Jonathan Corbet
2016-10-11 13:30   ` Johannes Berg
2016-10-11 21:39     ` Jonathan Corbet
2016-10-11 22:08       ` Johannes Berg
2016-10-12 17:20         ` Jonathan Corbet
2016-10-11 13:44   ` Johannes Berg
2016-10-11 13:53     ` Johannes Berg
2016-10-18 11:43       ` sequence diagrams in rst documentation Johannes Berg
2016-10-18 13:51         ` Markus Heiser
2016-10-18 14:12           ` Johannes Berg
2016-10-18 14:52             ` Jani Nikula
2016-10-18 19:20               ` Johannes Berg
2016-10-19 15:02               ` Markus Heiser
2016-10-19 15:17                 ` Jani Nikula
2016-10-18 23:52         ` Jonathan Corbet
2016-10-19  7:51           ` Johannes Berg
2016-10-21 12:31             ` Johannes Berg [this message]
2016-10-21 12:56               ` Jani Nikula
2016-10-21 13:04                 ` Johannes Berg
2016-10-21 16:11                   ` Markus Heiser
2016-10-21 21:17                     ` Johannes Berg
2016-10-21 21:19                     ` Johannes Berg
2016-10-22 16:37                       ` Markus Heiser
2016-10-22 20:30                         ` Johannes Berg

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1477053099.4068.42.camel@sipsolutions.net \
    --to=johannes@sipsolutions.net \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).