473,396 Members | 2,002 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,396 software developers and data experts.

Framework/module for generating HTML documentation

I have been maintaining a body of documentation in plain HTML files.

I would now like to automate the generation of the HTML files. Maintaining
the HTML files now is tedious and error prone, because every time I
move/remove/add a section, I have to renumber the following sections and
update my internal links.

I have looked at some of the HTML-generation frameworks, but the selection is
somewhat bewildering, and most also seem geared to generating dynamic or
static content for Websites. I guess what I am looking for is a Wiki-like
documentation generation engine, but generating a bunch of statically linked
files.

E.g., I want to go from something like this:
<h1>Introduction<h1>
<p>Some text</p>
<h1>Getting Started<h1>
<p>Some text</p>
<h2>Installation<h2>
<p>Some text. See <section>Getting Started</section> for details.</p>

To this:
[index.html]
<h1>Contents</h1>
<a href="1.html">1. Introduction</a>
<a href="1.html">2. Getting Started</a>
<blockquote>
<a href="1.html">2.1. Installation</a>
</blockquote>

[1.html]
<h1>1. Introduction<h1>
<p>Some text</p>
<a href="index.html">Contents</a> <a href="2.html">Next</a>

[2.html]
<h1>2. Getting Started<h1>
<p>Some text</p>
<a href="1.html">Prev</a> <a href="index.hml">Contents</a> <a
href="2_1.html">Next</a>

[2_1.html]
<h2>2.1. Installation<h2>
<p>Some text. See <a href="2.html">Getting Started</a> for details.</p>
<a href="2.html">Prev</a> <a href="index.hml">Contents</a> <a
href="2_2.html">Next</a>

If someone can recommend a framework/module that will help me achieve this, I
would greatly appreciate it. I could do it from scratch, but if this has been
tackled before (as I suspect it has), I'd like to stand on those developers'
shoulders <g>.

Regards,
Ryan

---
Ryan Ginstrom

Apr 4 '06 #1
1 1536
Hi,

I have a little script which creates numbers by scanning the <h?> tags.
But up to now it only works for single file. But it would be easy to
split e.g. on every <h2> tag.

http://www.thomas-guettler.de/script...eadings.py.txt

Am Tue, 04 Apr 2006 17:01:43 +0900 schrieb Ryan Ginstrom:
E.g., I want to go from something like this:
<h1>Introduction<h1>
<p>Some text</p>
<h1>Getting Started<h1>
<p>Some text</p>
<h2>Installation<h2>
<p>Some text. See <section>Getting Started</section> for details.</p>

To this:
[index.html]
<h1>Contents</h1>
<a href="1.html">1. Introduction</a>
<a href="1.html">2. Getting Started</a>
<blockquote>
<a href="1.html">2.1. Installation</a>
</blockquote>


--
Thomas Güttler, http://www.thomas-guettler.de/
E-Mail: guettli (*) thomas-guettler + de
Spam Catcher: ni**************@thomas-guettler.de

Apr 4 '06 #2

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

2
by: David McNab | last post by:
Hi, I'm looking for adventurous pre-alpha testers for a DHTML (active website) framework for Python I've developed. Name: - pyWeb Features:
1
by: Adrien Di Mascio | last post by:
Hi all, While reading the email module documentation, I found an error in a small example given for the as_string() method of the Message class: Here is the given code : (URL :...
17
by: Bart Nessux | last post by:
How can one view the contents of a queue? I'd like to verify that the queue has the same number of objects as the list that has been put into it. Also, should one think of a queue as static or...
25
by: Xah Lee | last post by:
Python Doc Problem Example: gzip Xah Lee, 20050831 Today i need to use Python to compress/decompress gzip files. Since i've read the official Python tutorial 8 months ago, have spent 30...
132
by: Kevin Spencer | last post by:
About 2 years ago, and as recently as perhaps 1 year ago, I can recall seeing many posts about what language to use with ASP.Net. The consensus was that employers paid more for C# programmers, and...
2
by: R.A.M. | last post by:
Hello, I am learning .NET 2.0. I need to learn how to create documentation from /// comments. I downloaded sample project XMLsample from Web and I generated XML documentation XMLsample.xml: ...
0
by: RCM | last post by:
I am really eager to quit the Microsoft world and get into LAMP. For the immediate future I can't do the Apache part, so I am at least trying to get PHP up and running under IIS to learn it. I...
21
KevinADC
by: KevinADC | last post by:
Note: You may skip to the end of the article if all you want is the perl code. Introduction Uploading files from a local computer to a remote web server has many useful purposes, the most...
9
by: YouCanCallMeAl | last post by:
It seems that the multiprocessing module in 2.6 is broken for *BSD; I've seen issue 3770 regarding this. I'm curious if there are more details on this issue since the posts in 3770 were a bit...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
0
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.