Opened 10 years ago

Closed 10 years ago

#12757 closed defect (fixed)

Clean up dead links in sage/modular/ documentation

Reported by: davidloeffler Owned by: craigcitro
Priority: major Milestone: sage-5.0
Component: modular forms Keywords:
Cc: Merged in: sage-5.0.beta12
Authors: David Loeffler Reviewers: Alex Ghitza
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

Using the sage -docbuild --warn-links command reveals a bunch of broken links in the modular forms reference manual:

<autodoc>:1: WARNING: py:class reference target not found: sage.structure.parent_base.ParentWithBase
<autodoc>:1: WARNING: py:class reference target not found: sage.structure.parent_base.ParentWithBase
<autodoc>:1: WARNING: py:class reference target not found: sage.structure.parent_base.ParentWithBase
<autodoc>:1: WARNING: py:class reference target not found: sage.structure.parent_base.ParentWithBase
/storage/masiao/sage-5.0.beta10/local/lib/python2.7/site-packages/sage/modular/local_comp/smoothchar.py:docstring of sage.modular.local_comp.smoothchar.SmoothCharacterGroupRamifiedQuadratic.change_ring:1: WARNING: py:meth reference target not found: base_extend
/storage/masiao/sage-5.0.beta10/local/lib/python2.7/site-packages/sage/modular/local_comp/smoothchar.py:docstring of sage.modular.local_comp.smoothchar.SmoothCharacterGroupRamifiedQuadratic.ideal:1: WARNING: py:meth reference target not found: sage.rings.number_field.number_field_ideal.idealstar
/storage/masiao/sage-5.0.beta10/local/lib/python2.7/site-packages/sage/modular/local_comp/smoothchar.py:docstring of sage.modular.local_comp.smoothchar.SmoothCharacterGroupRamifiedQuadratic.ideal:1: WARNING: py:meth reference target not found: sage.rings.number_field.number_field_ideal.ideallog
/storage/masiao/sage-5.0.beta10/local/lib/python2.7/site-packages/sage/modular/local_comp/smoothchar.py:docstring of sage.modular.local_comp.smoothchar.SmoothCharacterGroupUnramifiedQuadratic.change_ring:1: WARNING: py:meth reference target not found: base_extend
/storage/masiao/sage-5.0.beta10/local/lib/python2.7/site-packages/sage/modular/local_comp/smoothchar.py:docstring of sage.modular.local_comp.smoothchar.SmoothCharacterGroupUnramifiedQuadratic.ideal:1: WARNING: py:meth reference target not found: sage.rings.number_field.number_field_ideal.idealstar
/storage/masiao/sage-5.0.beta10/local/lib/python2.7/site-packages/sage/modular/local_comp/smoothchar.py:docstring of sage.modular.local_comp.smoothchar.SmoothCharacterGroupUnramifiedQuadratic.ideal:1: WARNING: py:meth reference target not found: sage.rings.number_field.number_field_ideal.ideallog
/storage/masiao/sage-5.0.beta10/local/lib/python2.7/site-packages/sage/modular/modform/cuspidal_submodule.py:docstring of sage.modular.modform.cuspidal_submodule.CuspidalSubmodule.change_ring:1: WARNING: py:meth reference target not found: base_extend
docstring of sage.modular.modform.eis_series_cython.eisenstein_series_poly:1: WARNING: py:class reference target not found: sage.libs.flint.fmpz_poly.Fmpz_poly
<autodoc>:1: WARNING: py:class reference target not found: sage.structure.parent_base.ParentWithBase

Attachments (1)

trac_12757-fix_broken_links.patch (7.3 KB) - added by davidloeffler 10 years ago.
Patch against 5.0.beta10

Download all attachments as: .zip

Change History (5)

Changed 10 years ago by davidloeffler

Patch against 5.0.beta10

comment:1 Changed 10 years ago by davidloeffler

  • Authors set to David Loeffler
  • Status changed from new to needs_review

Here's a patch. To test this, on a clean Sage branch run the commands

sage -docbuild --warn-links reference html
sage -hg qimport http://trac.sagemath.org/sage_trac/raw-attachment/ticket/12757/trac_12757-fix_broken_links.patch 
sage -hg qpush
find devel/sage/sage/modular/ -name "*.py*" | xargs touch
sage -b
sage -docbuild --warn-links reference html

This will make Sphinx rebuild all files in sage/modular (plus one or two others touched by this ticket), and you can verify that they all build without warnings.

comment:2 Changed 10 years ago by AlexGhitza

  • Reviewers set to Alex Ghitza
  • Status changed from needs_review to positive_review

The warnings are gone. Looks good to me.

comment:3 Changed 10 years ago by davidloeffler

Thanks for the review!

comment:4 Changed 10 years ago by jdemeyer

  • Merged in set to sage-5.0.beta12
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.