Changes between Version 21 and Version 28 of Ticket #9128


Ignore:
Timestamp:
04/27/11 21:17:25 (8 years ago)
Author:
hivert
Comment:

I upgraded my patch to the new sphinx. I'm not sure the patch is completely finished but I'd be very interesting to have feedback.

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #9128 – Description

    v21 v28  
    1616The following patch should solve this issue
    1717
    18 I also added an option {{{SAGE_DOC_WARN_DANGLING_LINKS}}} which raises some
    19 warnings if some links aren't resolved. For example:
    20 {{{
    21 WARNING: symbol :meth:`ModulesWithBasis.HomCategory.ElementMethods.on_basis` linked from sage.categories.modules_with_basis is defined in sage.categories.modules_with_basis but not documented
    22 WARNING: undefined symbol :class:`CartesianProducts.ParentMethods` in module sage.categories.modules_with_basis
    23 }}}
    24 Note those two warnings aren't raised because of a wrong doc but due to #9107.
     18I set up {{{intersphinx}}} so that links to Python's doc are correctly
     19resolved. The patch
     20[attachment:trac_9128-intersphinx_python_database-fh.patch] contains Python's
     21crossref database downloaded from http://docs.python.org/objects.inv I'm also
     22using intersphinx to solve links to the reference manual from the other
     23documents.
    2524
    26 I finally set up {{{intersphinx}}} so that links to Python's doc are correctly
    27 resolved. The file
    28 [http://trac.sagemath.org/sage_trac/attachment/ticket/9128/trac_9128-intersphinx_python_database-fh.patch trac_9128-intersphinx_python_database-fh.patch] contains
    29 Python's crossref database downloaded from http://docs.python.org/objects.inv
     25I finally setup the extension extlinks to allows links to trac as in
     26{{{:trac:`9128`}}}.
     27
     28Apply both:
     29
     30 - [attachment:trac_9128-intersphinx_python_database-fh.patch]
     31 - [attachment:trac_9128-sphinx_links_all-fh.patch]