Zsh Mailing List Archive
Messages sorted by: Reverse Date, Date, Thread, Author

Re: Modernizing Documentation format?



> On 18/08/2025 23:58 BST Clinton Bunch <cdb_zsh@xxxxxxxxxxx> wrote:
> 
>  
> I have gotten some ideas for converting our YODL (and Intro.ms) to 
> reStructuredText which requires some python modules (sphinx, rst2pdf) to 
> generate the output formats.  Python seems like a much more common 
> dependency than yodl, and I think we may be the last project using the 
> format.  Sphinx will generate man, html, pdf, and texi formats from 
> rst.  rst is not too step of a learning curve and is the de facto 
> standard for python documentation.
> 
> Any interest in seeing if I can get something usable converting the 
> format of record?

This certainly seems a good idea to me as we are a bit stuck in the
past.  I guess if there's some proof of concept that converts a short
chunk into all the relevant formats it might get more traction.  Much of
the later conversion should be scriptable with a final pass by hand.

The key people here are probably any who actively object to using the
format you propose.

pws




Messages sorted by: Reverse Date, Date, Thread, Author