Source

doxygen2rst /

Filename Size Date modified Message
1.7 KB
286 B
6.0 KB
286 B
2.2 KB
doxygen2rst
===========

This is a little script intended to parse Python source files and convert 
Doxygen-style comments to ReStructured Text style comments.  It is pretty crude 
and regexy, but it saves some manual labor.

To use:

 ./doxygen2rst /path/to/foo.py /path/to/bar.py
 
or 
 
 ./doxygen2rst /path/*.py
 
It prints an "Examining" line for each file that it opens, and after every file 
in which it finds changes it prints a status line, like so:

 Examining eventlet/__init__.py 
 Examining eventlet/saranwrap.py
 @brief 13 @param 15 @class 3


autoautodoc (aad)
===========

This script attempts to set up or update a doc directory so that it has a .rst
file for each source file.  It deliberately makes some assumptions about how
to arrange files and indices.

To use:
   ./autoautodoc /path/to/repo/src
   
Specifically, the path you supply must be to the actual source directory
within your repository -- aad will look for .py files in the directory given,
and will assume that docs should go in ../doc.

It gives feedback on its progress:

$ ./autoautodoc ~/rdw/llbase/llbase
Using source directory ~/rdw/llbase/llbase, doc directory ~rdw/llbase/doc
Updating Makefile's PYTHONPATH
Package name is: llbase
!! ~rdw/llbase/doc/config.rst does not exist, creating from template
!! ~rdw/llbase/doc/fastest_elementtree.rst does not exist, creating from template
!! ~rdw/llbase/doc/llidl.rst does not exist, creating from template
!! ~rdw/llbase/doc/llsd.rst does not exist, creating from template
!! ~rdw/llbase/doc/lluuid.rst does not exist, creating from template
Using index file /Users/rdw/Documents/src/llbase/doc/index.rst
Adding these entries to the toc: config, fastest_elementtree, llidl, llsd, lluuid


rdw@lindenlab.com