Carl Witty wrote:
> On Tue, Feb 24, 2009 at 10:42 PM, John H Palmieri
> <[email protected]> wrote:
>> One question: how do I build the documentation?
>
> With "sage -docbuild". Type just "sage -docbuild" to list all the
> possibilities; the simplest is just "sage -docbuild reference html",
> which will grind away for a while (about 10 minutes on my computer)
> and put the results in devel/sage/doc/output/html/en/reference.
>
> (It's much, much faster on subsequent runs; it's smart enough to only
> rebuild the parts of the documentation corresponding to modules that
> have changed.)
>
> Note that just editing a source file, then running "sage -docbuild"
> isn't enough to see the changed documentation; the documentation
> builder uses Python introspection, so you have to use "sage -b" to
> recompile before running docbuild.
>
Very nice!
sage -docbuild website html
and
sage -docbuild developer html
build the "fast static docs" very quickly. When I tried to build all of
the html documentation, though, I got the following:
$ sage -docbuild all html
sphinx-build -b html -d
/home/jason/sage/devel/sage/doc/output/doctrees/en/website .
/home/jason/sage/devel/sage/doc/output/html/en/website
Sphinx v0.5.1, building html
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
no targets are out of date.
Build finished. The built documents can be found in
/home/jason/sage/devel/sage/doc/output/html/en/website
Traceback (most recent call last):
File "/home/jason/sage/devel/sage/doc/common/builder.py", line 674,
in <module>
getattr(get_builder(name), type)(*args)
File "/home/jason/sage/devel/sage/doc/common/builder.py", line 261,
in _wrapper
getattr(get_builder(document), name)(*args, **kwds)
File "/home/jason/sage/devel/sage/doc/common/builder.py", line 291,
in html
os.path.realpath(os.path.join(html_output_dir, '..')))
File "/home/jason/sage/devel/sage/doc/common/builder.py", line 101,
in copytree
raise Error, errors
NameError: global name 'Error' is not defined
It looks like a "StandardError" or "RuntimeError" should be thrown and
caught, rather than "Error", on lines 92 and 101 of builder.py
Jason
--~--~---------~--~----~------------~-------~--~----~
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-devel
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---
