Hello, On Tue, Jun 9, 2009 at 1:57 AM, Simon King<[email protected]> wrote: > How can I tell sphinx where the modules-to-be-documented are?
Sphinx just tries to import the modules. It reads the docstrings, etc. via introspection. So, they just need to be somewhere where they can be imported by Python. > Looking at the sage documentation, I see that the names of the python > or cython files are given without their extension, the path starting > with 'sage/'. I guess that the current SAGE_ROOT+'/devel' branch is in > the path, so that the files are found. The reference manual is not the most straightforward place to start looking since there is some additional stuff that we do in devel/doc/common/builder.py to make it easy to add Sage modules to the reference manual. But, there are .rst files in devel/doc/en/reference/sage/ which are the ones that are being referred to. If you look at those, you'll just they primarily just ".. automodule::" directives. So, you'll just want to make .rst files which include the autodoc directives. > I am sorry to ask here, but in the documentation for sphinx I can't > see how to solve my problem. Could you please tell me how to turn my > doc-strings into a documentation? This is actually covered in the docs for the autodoc extension. --Mike --~--~---------~--~----~------------~-------~--~----~ 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/sage-support URLs: http://www.sagemath.org -~----------~----~----~----~------~----~------~--~---
