Atomatic building of documentation for a custom library

edit

I wouldn't imagine it would be that hard, if we could just automate the sphinx quickstart thing to add the files and then do whatever magic extracts the function definitions in Sage's ReST format. I'd be very open to reviewing any work you do on that ;)

I've been playing with it for the last day. I may have something soon. One issue is to decide where to do the building; I think it makes most sense to do everything in the user's .sage directory.

Shame on me: http://ask.sagemath.org/question/432/using-sphinx-to-document-a-module-using-sage. Still, I would say it is not a perfect solution.

I had a feeling, but was also too lazy... not perfect, but certainly doable.

See also http://trac.sagemath.org/sage_trac/ticket/13679. This works for me with .py and .sage files, but not with .pyx files.

That's beyond wonderful! Unfortunately, I have encountered some problems after applying the patch: (1) 'autodoc can't import/find module ...', so where should I put the file?; and (2) the file name contains an underscore, which sphinxs is treating like a math subscript. But, really, thanks for the quick solution! :)

Finally worked: I had to run it from the sage shell, rename the file to a .py (it was .sage) and add the corresponding path to the $PYTHONPATH of the sage shell. Interestingly, a couple of spurious functions that were not in the module did appear in the documentation. Cheers!