On Jan 16, 10:07 pm, [email protected] wrote: > Hi, Good evening.
> 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? I tried your script and it did the job quite nice. Correct me if I wrong, but this is "one time" script - I can run it only once. If I modify the generated files, the script will not preserve the changes. May be the better solution is to add :autopackage: directive, which has the following properrties/attributes: * "understand" __init__.py file role * :maxdepth: * support merge of hand-written documentation and the one extracted from code ( http://sphinx.pocoo.org/ext/autodoc.html?highlight=autodoc#module-sphinx.ext.autodoc ), * include/exclude glob patterns May be Sphinx should introduce :pkg: directive, which allows to refer to the whole package. What do you think? --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
