Re: ASCII diagrams and RST/Sphinx documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sat, 05 Nov 2016, Jarkko Sakkinen <jarkko.sakkinen@xxxxxxxxxxxxxxx> wrote:
> Hi
>
> I recently submitted patches to move the existing TPM driver
> documentation to the new scheme. There is one document that I left in
> its original form, namely xen-tpmfront.txt, because it contains ASCII
> diagrams.
>
> My question is how to deal with these diagrams? Should I just define
> them as blocks of preformatted text?

Right now, using preformatted text seems to be the way to make forward
progress. There are unresolved issues with svg and latex/pdf output [1].


BR,
Jani.


[1] http://lkml.kernel.org/r/20161107075524.49d83697@xxxxxxxxx


>
> I don't know if it is technically feasible but one idea that popped into
> my mind is the following:
>
> * There could be an option to import an svg file that would be consumed
>   by the scripts that generate the documentation.
> * You could provide the ASCII diagram as an "alt text" when viewing the
>   rst file.
>
> /Jarkko
> --
> To unsubscribe from this list: send the line "unsubscribe linux-doc" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

-- 
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux