Groups | Search | Server Info | Login | Register


Groups > comp.text > #1388

[Linux] Tool Chain to generate documentation

Path csiph.com!news.swapon.de!news.mb-net.net!open-news-network.org!.POSTED!not-for-mail
From Michael Uplawski <michael.uplawski@uplawski.eu>
Newsgroups comp.text, comp.text.pdf
Subject [Linux] Tool Chain to generate documentation
Supersedes <AABpgb-Wa8wAAJgH.A3.flnews@ferrat.uplawski.eu>
Followup-To comp.text
Date Tue, 3 Feb 2026 10:31:55 +0100
Organization mediocre
Message-ID <AABpgcCLFYwAAJgH.A3.flnews@ferrat.uplawski.eu> (permalink)
MIME-Version 1.0
Content-Type text/plain; charset=UTF-8; format=fixed
Content-Transfer-Encoding 8bit
Injection-Date Tue, 3 Feb 2026 09:31:55 -0000
Injection-Info gwaiyur.mb-net.net; logging-data="1183866"; mail-complaints-to="abuse@open-news-network.org"
User-Agent flnews/1.3.0 (for GNU/Linux)
Cancel-Key sha256:bzgXUdZWlv6nsTtuBIbWkTIoHX6fbIpWRBmxcHBO3ZQ= sha1:dAKIP/5t0YLvyAvlBljyddfAZzE= sha256:agrkCA0pz0GCK9ICvkq2aWsWovoqXSlGSqW9OQZjGZA=
Cancel-Lock sha256:MTJ6GQc5iIWqaGnCkj38vuvmbbol7POEgVSxs/2R9Dc= sha1:Npva5l1vDahiDTJguBDGMsc9vPQ= sha256:kU2vT7egETkZpzfFW/DoAVOQSnXF6YGQjzvCvV6LdyQ= sha1:eYwUkMYJYSXmPxUJlOmjnyBOA9o= sha256:UtiF5FcAAWnwCerUVDOG8eVBJFHr4iIKBsWygcRRO6Y=
X-My-Languages German - native, English - solid, French - assez correcte
X-Post-Processor flnews_post_proc 1.94
X-Gnupg dsa3072 2025-04-17 13E0B7954B33EB38D1A994F7B557E6B1CE3F0112
Xref csiph.com comp.text:1388 comp.text.pdf:2721

Cross-posted to 2 groups.

Followups directed to: comp.text

Show key headers only | View raw


Supersede for duplicate http in the url

Good morning

For my own documentation needs I have developed a routine (as in
“habit” as opposed to “programmed system”) which allows me to have
HTML, man-pages and PDFs generated from an initial reStructuredText
file. Shell scripts are important in this tool-chain and calling one
shell script triggers the transformations. I use otherwise software
that is rather standard and easily accessible on a Linux-system.

Before I present you the URL, PSE understand that this is not meant
to identify “Best Practices”, not even to describe an “optimized”
procedure. Deficiencies can be explained by a lack of knowledge on
my side or by a compromise that I accept in order to get the most
out of one tool or the other …

The page is Work-in-Progress until further notice, as I tend to find
new uses for the tools (and also new tools for the uses) or details
that need further clarification. 

Also, I am certain that not everything is *needed* all the time. I
publish this page, because I call the procedure now somewhat complete:

<https://www.uplawski.eu/software/doc/>

Shoot at own discretion. The only thing that I cannot accept is that
this would not work. I use it. It works.

TIA for any comments. X-post to comp.text.pdf, because PDF needs 
a considerable amount of devotion; modify the newsgroup for the F'ups, 
if you prefer.

Michael

Back to comp.text | Previous | Find similar


Thread

[Linux] Tool Chain to generate documentation Michael Uplawski <michael.uplawski@uplawski.eu> - 2026-02-03 10:31 +0100

csiph-web