2013/12/13 Rainer Gerhards <[email protected]>: >>>> >>>> https://github.com/rgerhards/rsyslog/blob/master/doc/build_ >>>> from_repo.htmlmore >>>> prominent (and markup, not HTML) >>>> >>>> "markup, not HTML" easy said... >>> >> >> Indeed, but this is a major problem with rsyslog documentation. HTML does >> not imply anything about how things should look. Therefore, >> differently-looking doc pages become an ugly, unstructured heap. This also >> prevents others to contribute or improve docs. >> >> Many years ago, I've used Perl POD in an alike situation. It is >> oversimplified, and this allows to concentrate on contents. It helped in my >> case. But I do not think this one is suitable for rsyslog. >> >> I hope someone knows a format which will fit rsyslog better. >> >> > RST is a good fit, as Radu said. But it also needs work, both for setting > up the build system as well as converting the existing doc set. Would > definitely be a win. New things I've authored in RST.
Regarding RST: I recently used spinhx doc [1] to write a software documentation and kinda liked it. Both the output and the simple input. [1] http://sphinx-doc.org/contents.html -- Why is it that all of the instruments seeking intelligent life in the universe are pointed away from Earth? _______________________________________________ rsyslog mailing list http://lists.adiscon.net/mailman/listinfo/rsyslog http://www.rsyslog.com/professional-services/ What's up with rsyslog? Follow https://twitter.com/rgerhards NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE THAT.
