Re: The downside of math::

From	Jani Nikula <jani.nikula@linux.intel.com>
Newsgroups	linux.kernel
Subject	Re: The downside of math::
Date	2016-10-24 10:30 +0200
Message-ID	<svINQ-53o-21@gated-at.bofh.it> (permalink)
References	(1 earlier) <su9p7-cb-1@gated-at.bofh.it> <sumZ3-wo-19@gated-at.bofh.it> <suPHH-2MQ-21@gated-at.bofh.it> <svoFr-8iu-1@gated-at.bofh.it> <svIkN-4BM-11@gated-at.bofh.it>
Organization	Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo

Show all headers | View raw

On Mon, 24 Oct 2016, Johannes Berg <johannes@sipsolutions.net> wrote:
> On Sun, 2016-10-23 at 12:58 +0200, Markus Heiser wrote:
>> Further I think we should not generate more (and more) external
>> requirements like e.g. plantuml, Java or reportlab discussed here:
>
> I still disagree, I think we should make it easy to "opt out" for the
> build, but if we're really serious about writing good documentation we
> shouldn't (artificially) limit the tools available.

I'd like to refine: Do not add non-trivial hard dependencies. Do not add
dependencies the lack of which make large parts of generated
documentation useless.

Graceful degradation on unmet dependencies is the key here. Give a build
warn about missing dependencies. Try to do something sensible without
the dependency. For extension directives, all else failing, embed the
raw directive block contents using in the output, possibly accompanied
by a reStructuredText admonition block [1]. For the math and diagram
directives, I think this would work just fine.

BR,
Jani.

[1] http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions

-- 
Jani Nikula, Intel Open Source Technology Center

Back to linux.kernel | Previous | Next — Previous in thread | Find similar | Unroll thread

Thread

The downside of math:: Jonathan Corbet <corbet@lwn.net> - 2016-10-20 01:10 +0200
  Re: The downside of math:: Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-20 02:30 +0200
    Re: The downside of math:: Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-20 02:50 +0200
    Re: The downside of math:: Jani Nikula <jani.nikula@linux.intel.com> - 2016-10-20 17:00 +0200
      Re: The downside of math:: Markus Heiser <markus.heiser@darmarit.de> - 2016-10-20 17:20 +0200
      Re: The downside of math:: Jonathan Corbet <corbet@lwn.net> - 2016-10-21 23:40 +0200
        Re: The downside of math:: Markus Heiser <markus.heiser@darmarit.de> - 2016-10-23 13:00 +0200
          Re: The downside of math:: Johannes Berg <johannes@sipsolutions.net> - 2016-10-24 10:00 +0200
            Re: The downside of math:: Johannes Berg <johannes@sipsolutions.net> - 2016-10-24 10:30 +0200
              Re: The downside of math:: Jani Nikula <jani.nikula@linux.intel.com> - 2016-10-24 11:10 +0200
            Re: The downside of math:: Jani Nikula <jani.nikula@linux.intel.com> - 2016-10-24 10:30 +0200

csiph-web