ASKSAGE: Sage Q&A Forum - RSS feedhttps://ask.sagemath.org/questions/Q&A Forum for SageenCopyright Sage, 2010. Some rights reserved under creative commons license.Mon, 01 Oct 2012 06:29:46 +0200making docstrings using sphinx -- need a bit of helphttps://ask.sagemath.org/question/9373/making-docstrings-using-sphinx-need-a-bit-of-help/Hi,
I've done the following:
1) Downloaded ``sudo apt-get install python-setuptools`
2) Downloaded ``easy_install -U sphinx`` then navigated to my project directory ...sage/<project-name>
3) Ran ``sage -sh `` and ``sphinx-quickstart`` and followed the defaults except I chose separate directories for my build and source files.
4) Ran ``make latex`` and``make latexpdf``
It's blank! Please advise.
How can I ensure it picks up certain .py files? Any tips?SLOtoSFMon, 01 Oct 2012 06:29:46 +0200https://ask.sagemath.org/question/9373/Using Sphinx to document a module using Sagehttps://ask.sagemath.org/question/7996/using-sphinx-to-document-a-module-using-sage/Hi all
I wrote a module using sage (first line : `from sage.all import *`)
My module contains quite a lot of docstrings with doctests that I want to be exported in html.
Following the documentation of Sphinx, I can create the source directory, but `make html` does not work :
<blockquote><p> "No module named sage.all" </p></blockquote>
Well. I understand why, but I don't see how to get further. The Sage's documentation says [how to sphinxify](http://www.sagemath.org/doc/reference/sagenb/misc/sphinxify.html) one docstring, but what I want is a html file with *all* my doctrings, that is, as far as I understood, the result of that :
.. automodule:: mymodule
:members:
I'm sure that it is possible : the whole documentation of Sage itself is made like that :)
In one word, I want to do "docstrings of my module -> html".
Any help is accepted
Thanks
Laurent
Laurent ClaessensSun, 13 Mar 2011 11:48:14 +0100https://ask.sagemath.org/question/7996/