Groups | Search | Server Info | Login | Register

Groups > comp.text > #1388

[Linux] Tool Chain to generate documentation

Cross-posted to 2 groups.

Followups directed to: comp.text

Show all headers | 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