473,657 Members | 2,478 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

DocumentationTo ols (docstring --> html)

Hi,

I want to create documentation in html
from docstrings. According to this URL,
there are many projects:

http://www.python.org/cgi-bin/moinmo...mentationTools

* PyDoc, http://web.pydoc.org/
* DocUtils, http://docutils.sourceforge.net/ ReStructuredTex t processing engine
* EpyDoc, http://epydoc.sourceforge.net/
* HappyDoc, http://happydoc.sourceforge.net/
* PythonDoc - uses ReStructuredTex t input format, and can produce HTML and XML output. It uses XML as an intermediate representation, to simplify the addition of new output formats. http://starship.python.net/crew/danilo/pythondoc/
* Crystal - produces output that is similar to [Wiki]JavaDoc.
* EasyDoc - uses an HTML-like markup language, similar to the language used by [Wiki]JavaDoc; and produces HTML output (http://htmltmpl.sourceforge.net/easydoc.html)
* Teud, [EfnetPythonWiki]TeudProject

Can someone give me an advice which one to
choose?

Thomas

Jul 18 '05 #1
1 2697
"Thomas Guettler" <gu*****@thom as-guettler.de> wrote in message
news:pa******** *************** *****@thomas-guettler.de...
Hi,

I want to create documentation in html
from docstrings. According to this URL,
there are many projects:

http://www.python.org/cgi-bin/moinmo...mentationTools

* PyDoc, http://web.pydoc.org/
* DocUtils, http://docutils.sourceforge.net/ ReStructuredTex t processing engine * EpyDoc, http://epydoc.sourceforge.net/
* HappyDoc, http://happydoc.sourceforge.net/
* PythonDoc - uses ReStructuredTex t input format, and can produce HTML and XML output. It uses XML as an intermediate representation, to simplify
the addition of new output formats.
http://starship.python.net/crew/danilo/pythondoc/ * Crystal - produces output that is similar to [Wiki]JavaDoc.
* EasyDoc - uses an HTML-like markup language, similar to the language used by [Wiki]JavaDoc; and produces HTML output
(http://htmltmpl.sourceforge.net/easydoc.html) * Teud, [EfnetPythonWiki]TeudProject

Can someone give me an advice which one to
choose?

Thomas

I found EpyDoc *very* easy to use, and the results are beautiful!

-- Paul
Jul 18 '05 #2

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

Similar topics

4
2476
by: jason | last post by:
I would appreciate some help on how to convert a database table into an html file via FSO and whether more seasoned asp programmers recommned this route. The main reason I am attempting to do this is becuase we are constantly being told by so-called marketing gurus that 'html' pages are more search engine friendly. Other advantages include speed of download. Will there be any problems with using this approach besides establishing...
3
2111
by: Jan Plastenjak | last post by:
This question is about html. I have this: <frameset rows="90%,10%" frameborder="NO" border="0" framespacing="0" cols="1"> <frame name="topFrame" noresize src="c:\bpp.xml"> <frame name="bottom" scrolling="NO" noresize src="c:\btn.htm"> </frameset> Is there a way to assign html code to frames "in code", not to have to specify src property? Something like:
0
1196
by: brainless | last post by:
Hello, I basically know nothing about XML but want to use it in what I think sounds like a very simple form. I've used the ADO.RECORDSET.SAVE method to save the query results set as an XML file. I now want to show the results of this file in a HTML table. How do I do this?
6
2449
by: John Kooistra | last post by:
Hi! I'm looking to generate an HTML table via XSL using XML data. Specifically, I want to arrange my data in a table with rows of 6 columns. So, I have this conditional XSL statement setup to open and close <tr>'s when appropriate. Unfortunately, the XSL parser doesn't like the fact that within the <xsl:when> block there is no closing tag for <tr>. (ie. Receive the
2
1193
by: Albert | last post by:
Hello all I am using a datafeed that provides me with a Javascript that spits out a bunch of hyperlinks to other locations. Her is what it looks like: <script language="javascript" src=http://datafeed.XXXXXX.com/YYY.asp?area=XX&stories=10&url=www.ABC.com> </script>
0
971
by: Rick Walsh | last post by:
I am using the following code to export a dataset via xml and xsl to html: ------------------------------------------------------------- .. .. .. Dim dataDoc as new XmlDataDocument(myDataSet) Dim obj_transform As new XslTransform()
6
7084
by: Joerg Battermann | last post by:
Hey there, mmmm does anyone know a library or anything I can use to convert plaintext to html real quick and vice-versa? Regex surely would do the trick to a certain level, but maybe there's already a useful library out there which I might have a look at.. Thanks, -J
6
6067
by: Just D. | last post by:
Does anybody know if there any open source project written in C# as a class library allowing to convert RTF string into HTML string? I'd like to join this project for the interest of both sides. I can start writing this component from scratch for sure, but first of all I've seen a lot of commercial projects and it's not very interesting. From another side we could use our combined efforts with somebody to improve the existing project if it...
7
5096
by: mark | last post by:
Hi All, Apologies for the newbie question but I've searched and tried all sorts for a few days and I'm pulling my hair out ; Please feel free to teach me to suck eggs because it's all new to me :) Thanks in advance, Mark.
0
8842
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, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
1
8513
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 Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
0
8617
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 protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
1
6176
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
5642
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...
0
4173
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
0
4330
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
2742
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
2
1970
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.

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.