[Linux] Generate Documentation quickly

Talk about miscellaneous stuff that doesn't fit anywhere else. Off-topic discussions encouraged.
Post Reply
User avatar
Michael Uplawski
Posts: 209
Joined: Thu Dec 11, 2014 11:43 pm
Location: Canton Magny, Normandy

[Linux] Generate Documentation quickly

Post by Michael Uplawski »

Good morning

I describe a way to generate HTML, man-pages and PDF-files from 1 reStructuredText (raw text) document.

Wanting to use only readily available software, I had to accustom to these, and as nobody seems to be interested in too much interoperability, shell-scripting becomes an integral part of the process. But those of you who are less exigent or want only one file-type may find inspiration.
Okay, courageous as I feel this morning, here is the URL: https://www.uplawski.eu/software/doc/index.html

WIP means “work in progress”, of course, but expresses much more than that. The files that I reference and less frequently also the text of the linked page may and will probably change in the future, as I am learning things and am correcting ill-chosen commands against better ones.

But it is also about attitude and feasibility.

I hope that I am not conveying too much pride, as that would be misplaced, here. You could find now, that it is easy to produce man-pages and as many of you know to do it better than most of the actual authors of the doc that comes with Linux, you may finally be tempted to write comprehensible manuals. Or you can become so detached and serene that you can just ignore the whole topic. Both would be okay, I guess.

What I feel is bafflement and frustration. From the early nineties to today.., this should be it?
Hindsight is in the eye of the beholder.
Post Reply

Return to “Water Cooler”