#9128: Sphinx should be aware of all.py to find its links
------------------------------+---------------------------------------------
Reporter: hivert | Owner: hivert
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.4.4
Component: documentation | Keywords: Sphinx links
Author: Florent Hivert | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
------------------------------+---------------------------------------------
Comment(by novoselt):
I have just upgraded an installation of sage-4.4.2 to 4.4.3, applied this
patch, set SAGE_DOC_WARN_DANGLING_LINKS to 1, and then got the following
error:
{{{
novos...@sage:/scratch/novoselt/sage/devel/sage-main$ ../../sage -docbuild
reference html
sphinx-build -b html -d
/mnt/usb1/scratch/novoselt/sage/devel/sage/doc/output/doctrees/en/reference
/mnt/usb1/scratch/novoselt/sage/devel/sage/doc/en/reference
/mnt/usb1/scratch/novoselt/sage/devel/sage/doc/output/html/en/reference
Running Sphinx v0.6.3
loading pickled environment... done
building [html]: targets for 798 source files that are out of date
updating environment: [config changed] 802 added, 0 changed, 0 removed
reading sources... [100%] structure
/mnt/usb1/scratch/novoselt/sage/local/lib/python2.6/site-
packages/sage/schemes/elliptic_curves/sha_tate.py:docstring of
sage.schemes.elliptic_curves.sha_tate.Sha.bound_kato:12: (WARNING/2)
Definition list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 0%] coercion
Exception occurred:
File "/mnt/usb1/scratch/novoselt/sage/devel/sage/doc/common/conf.py",
line 444, in find_sage_dangling_links
fromdocname = getattr(sys.modules[modname], basename).__module__
KeyError: None
The full traceback has been saved in /tmp/sphinx-err-Unu279.log, if you
want to report the issue to the author.
Please also report this if it was a user error, so that a better error
message can be provided next time.
Send reports to [email protected]. Thanks!
Build finished. The built documents can be found in
/mnt/usb1/scratch/novoselt/sage/devel/sage/doc/output/html/en/reference
novos...@sage:/scratch/novoselt/sage/devel/sage-main$
}}}
Then I removed this patch, built documentation successfully, pushed this
and some other patches and now it seems to work fine. Perhaps it was an
unreproducible glitch unrelated to the patch. In general it seems to work
as expected and showed me a couple of mistakes in my modules.
I hesitate to switch status to positive review because of the error above
and because I don't really understand the code, but I think that this is a
great addition and will use this patch from now on!
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9128#comment:6>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
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-trac?hl=en.
