On 9/21/07, David Joyner <[EMAIL PROTECTED]> wrote: > On 9/21/07, William Stein <[EMAIL PROTECTED]> wrote: > > On 9/21/07, Jason Grout <[EMAIL PROTECTED]> wrote: > > > I changed some of the documentation in graphs/graph.py (formatted it > > > using Latex). How do I build a new manual to see my changes? > > > > cd SAGE_ROOT/devel/doc/ref > > ./build_pdf > > > > That will create ref.pdf, which you can view. This *requires* that you > > have latex2html correctly installed, which -- due to its screwy > > license -- often isn't installed on machines by default. > > > Would this method also work for docstrings files which are not included in the > reference manual? (Ie, for newly created *.py files.)
No, this will certainly not work for such docstrings -- I would like something that does. This should be put into a trac ticket. By the way, you *can* simply add the new file by making an empty file with the right now (but replace _ by -). Then include it in ref.tex. There is actually now a massive amount of code that has lots of documentation but isn't in the reference manual. This needs to change. Of course, then the reference manual will go from 2,200 pages to 4,000 pages... William > > > > > > Going to > > > the doc directory and typing "make pdf" seems to just pick up the old > > > sage.graphs.graph.tex file and not generate a new one from the python > > > source. > > > > That would also work, but you have to first do > > ./update > > in the SAGE_ROOT/devel/doc/ref/ directory. > > > > > Did I miss something in the documentation? > > > > No, you didn't miss anything, since the build > > system is unfortunately not really documented. > > > > There is a minimal README.txt in > > SAGE_ROOT/devel/doc/ref/ > > > > If anybody understands the build system and > > wants to document the above sort of thing, please > > post a patch to trac against the doc repository. > > > > William > > > > > > > > > > > -- William Stein Associate Professor of Mathematics University of Washington http://wstein.org --~--~---------~--~----~------------~-------~--~----~ To post to this group, send email to sage-devel@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sage-devel URLs: http://sage.scipy.org/sage/ and http://modular.math.washington.edu/sage/ -~----------~----~----~----~------~----~------~--~---
