473,326 Members | 2,133 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,326 software developers and data experts.

Python source cross reference doc generator?

Hi All,

Wondering if a tool exists to generate "cross reference" documentation
for Python code bases?

Particularly after something like phpxref -
http://phpxref.sourceforge.net/ : written in Perl, scans a bunch of
PHP scripts and generates HTML output that allows you to see all the
classes / methods / functions / variables defined and (what I'm
interested in) where they are referenced. Essentially something like
API docs but with the addition of being able to see who's using a
particular method

Is there anything like this for Python? Have done much looking without success.

Many thanks.
Mar 11 '06 #1
3 4327
Harry Fuecks wrote:
Hi All,

Wondering if a tool exists to generate "cross reference" documentation
for Python code bases?

Particularly after something like phpxref -
http://phpxref.sourceforge.net/ : written in Perl, scans a bunch of
PHP scripts and generates HTML output that allows you to see all the
classes / methods / functions / variables defined and (what I'm
interested in) where they are referenced. Essentially something like
API docs but with the addition of being able to see who's using a
particular method

Is there anything like this for Python? Have done much looking without success.

Many thanks.

epydoc and pydoc each provides an index. If you are looking for info on
where a name is defined or used, PyScripter is helpful.

Colin W.
Mar 11 '06 #2

Colin J. Williams wrote:
Harry Fuecks wrote:
Hi All,

Wondering if a tool exists to generate "cross reference" documentation
for Python code bases?

Particularly after something like phpxref -
http://phpxref.sourceforge.net/ : written in Perl, scans a bunch of
PHP scripts and generates HTML output that allows you to see all the
classes / methods / functions / variables defined and (what I'm
interested in) where they are referenced. Essentially something like
API docs but with the addition of being able to see who's using a
particular method

Is there anything like this for Python? Have done much looking without success.

Many thanks.

epydoc and pydoc each provides an index. If you are looking for info on
where a name is defined or used, PyScripter is helpful.

Colin W.


you can also take a look at Komodo's Object browser and wing's
Class/module browsers

Mar 12 '06 #3
"Harry Fuecks" <hf*****@gmail.com> wrote in message news:ma***************************************@pyt hon.org...
Wondering if a tool exists to generate "cross reference" documentation
for Python code bases?


PyXR does cross referencing. epydoc generates good doc from comments
(javadoc style):

http://pyxr.sourceforge.net/
http://epydoc.sourceforge.net/

This their output run over a non-trivial codebase:

http://www.bitpim.org/pyxr/
http://www.bitpim.org/apidoc/

It would be really nice if they were both integrated together.

Roger
Mar 12 '06 #4

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

Similar topics

1
by: logistix | last post by:
PyXR 0.9.3- Cross-Referenced HTML from Python Source PyXR generates HTML pages from python source files. It also generates cross-referenced hyperlinks and integrates with the Python Library...
699
by: mike420 | last post by:
I think everyone who used Python will agree that its syntax is the best thing going for it. It is very readable and easy for everyone to learn. But, Python does not a have very good macro...
0
by: Emile van Sebille | last post by:
QOTW (advanced interfaces track): "I'm firmly in favour of any language that can DWIMNWIS." -- Tim Delaney QOTW (MS roadkill track): "Underestimate MS at your own risk. It is one thing to not...
2
by: Limin Fu | last post by:
Hello, Is there any technical description on internet of how python is designed? Or can somebody give a short description about this? I'm just curious. Thanks in advance, Limin
10
by: Andrew Dalke | last post by:
Is there an author index for the new version of the Python cookbook? As a contributor I got my comp version delivered today and my ego wanted some gratification. I couldn't find my entries. ...
0
by: Kurt B. Kaiser | last post by:
Patch / Bug Summary ___________________ Patches : 349 open ( +7) / 3737 closed (+25) / 4086 total (+32) Bugs : 939 open (-12) / 6648 closed (+60) / 7587 total (+48) RFE : 249 open...
0
by: DolphinDB | last post by:
Tired of spending countless mintues downsampling your data? Look no further! In this article, you’ll learn how to efficiently downsample 6.48 billion high-frequency records to 61 million...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 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 former...

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.