Opened 21 months ago

Last modified 3 months ago

#13323 new enhancement

upgrade docutils to version 0.9.1

Reported by: slabbe Owned by: tbd
Priority: major Milestone: sage-6.2
Component: packages: standard Keywords:
Cc: Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

The latest release package is docutils-0.9.1.tgz. It was released on 2012-06-17.

The actual docutils version in Sage (since 4.7.1 #10166) is 0.7 released on 2009-10-11

One should make sure to avoid the problem fixed at #11660 (docutils files not world-readable).

Change History (7)

comment:1 Changed 21 months ago by slabbe

A new spkg version is here :

http://sage.math.washington.edu/home/slabbe/docutils-0.9.1.p0.spkg

I still haven't build sage from source with this new package. I will change the status to needs review once I did it.

Last edited 21 months ago by slabbe (previous) (diff)

comment:2 Changed 21 months ago by slabbe

Ok, it is not so easy. Sage compiles fine. But, Sphinx v1.1.2 has trouble building the documentation with the version 0.9.1 of docutils. Here is a part of dochtml.log :

Setting permissions of DOT_SAGE directory so only you can read and write it.
sphinx-build -b html -d /home/slabbe/sage-5.2/devel/sage/doc/output/doctrees/en/reference   -A hide_pdf_links=1  /home/slabbe/sage-5.2/devel/sage/doc/en/reference /home/slabbe/sage-5.2/devel/sage/doc/output/html/en/reference
Running Sphinx v1.1.2
loading pickled environment... not yet created
loading intersphinx inventory from /home/slabbe/sage-5.2/devel/sage/doc/common/python.inv...
building [html]: targets for 1040 source files that are out of date
updating environment: 1040 added, 0 changed, 0 removed
reading sources... [  0%] algebras
reading sources... [  0%] arithgroup
reading sources... [  0%] calculus
reading sources... [  0%] categories
reading sources... [  0%] cmd
reading sources... [  0%] coding
reading sources... [  0%] coercion

Exception occurred:
  File "/home/slabbe/sage-5.2/local/lib/python2.7/site-packages/Sphinx-1.1.2-py2.7.egg/sphinx/util/nodes.py", line 183, in set_role_source_info
    inliner.reporter.locator(lineno)
AttributeError: Reporter instance has no attribute 'locator'
The full traceback has been saved in /tmp/sphinx-err-TDfXeg.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
Either send bugs to the mailing list at <http://groups.google.com/group/sphinx-dev/>,
or report them in the tracker at <http://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
Build finished.  The built documents can be found in /home/slabbe/sage-5.2/devel/sage/doc/output/html/en/reference
sphinx-build -b html -d /home/slabbe/sage-5.2/devel/sage/doc/output/doctrees/en/faq   -A hide_pdf_links=1  /home/slabbe/sage-5.2/devel/sage/doc/en/faq /home/slabbe/sage-5.2/devel/sage/doc/output/html/en/faq
Running Sphinx v1.1.2
loading pickled environment... not yet created
loading intersphinx inventory from /home/slabbe/sage-5.2/devel/sage/doc/common/python.inv...
loading intersphinx inventory from /home/slabbe/sage-5.2/devel/sage/doc/output/html/en/reference/objects.inv...
WARNING: intersphinx inventory '/home/slabbe/sage-5.2/devel/sage/doc/output/html/en/reference/objects.inv' not fetchable due to <type 'exceptions.IOError'>: [Errno 2] No such file or directory: '/home/slabbe/sage-5.2/devel/sage/doc/output/html/en/reference/objects.inv'
building [html]: targets for 4 source files that are out of date
updating environment: 4 added, 0 changed, 0 removed

I tested the compilation here on sage.math.

comment:3 Changed 21 months ago by slabbe

This seems to be fixed here

https://bitbucket.org/birkenfeld/sphinx/changeset/bab0b83c9e02

and available in Sphinx v1.1.3 (Mar 10, 2012).

Last edited 21 months ago by slabbe (previous) (diff)

comment:4 Changed 18 months ago by r.gaia.cs

Hi, I the problem similar to the one reported by slabbe building the documentation of sage-5.4.rc3.

comment:5 Changed 11 months ago by Snark

For your information, you'll also hit errors looking like:

[combinat ] /home/jpuydt/sage-5.9.debian/local/local/lib/python2.7/dist-packages/sage/combinat/free_module.py:docstring of sage.combinat.free_module.CombinatorialFreeModule:60: ERROR: Error in "note" directive:
[combinat ] invalid option block.
[combinat ] .. note:: These print options may also be accessed and modified using the
[combinat ] :meth:`print_options` method, after the module has been defined.

which are explained here.

Notice also that docutils are now up to version 0.10.

comment:6 Changed 8 months ago by jdemeyer

  • Milestone changed from sage-5.11 to sage-5.12

comment:7 Changed 3 months ago by vbraun_spam

  • Milestone changed from sage-6.1 to sage-6.2
Note: See TracTickets for help on using tickets.