Hi, I start to use Sphinx for our project (http://propulseart.sat.qc.ca) and I wish to autogenerate all the docs from the code (à la epydoc). So I have written a script that parse the directory tree of a project/ package and create all the ReST files (with the automodule directive in it) necessary to produce the docs from the code.
I was wondering if you think it could be a good idea to bundle a script of this kind with Sphinx? You can see my script here: https://svn.sat.qc.ca/trac/miville/browser/trunk/py/docs/generate_modules.py It's a first version but I think it could easily modify/extend to be more generic and flexible. For example I can use optparse to add some flags to specifiy the automodule options or add a flag to specify a file with a list of exclusions. Maybe it could be a good idea to add a configuration file to keep the settings, etc. To use it you call it with the package directory as first argument. All others arguments are path that will be excluded from the processing. As a matter of fact, I just added 2 proposals and 4 bug report to the Sphinx issue tracker! And thanks for the great work. Etienne --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~----------~----~----~----~------~----~------~--~---
