Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up dead links in sage/modular/ documentation #12757

Closed
loefflerd mannequin opened this issue Mar 27, 2012 · 7 comments
Closed

Clean up dead links in sage/modular/ documentation #12757

loefflerd mannequin opened this issue Mar 27, 2012 · 7 comments

Comments

@loefflerd
Copy link
Mannequin

loefflerd mannequin commented Mar 27, 2012

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

Component: modular forms

Author: David Loeffler

Reviewer: Alex Ghitza

Merged: sage-5.0.beta12

Issue created by migration from https://trac.sagemath.org/ticket/12757

@loefflerd loefflerd mannequin added this to the sage-5.0 milestone Mar 27, 2012
@loefflerd loefflerd mannequin assigned craigcitro Mar 27, 2012
@loefflerd
Copy link
Mannequin Author

loefflerd mannequin commented Mar 27, 2012

Attachment: trac_12757-fix_broken_links.patch.gz

Patch against 5.0.beta10

@loefflerd
Copy link
Mannequin Author

loefflerd mannequin commented Mar 27, 2012

comment:1

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

sage -docbuild --warn-links reference html
sage -hg qimport https://github.com/sagemath/sage-prod/files/10655225/trac_12757-fix_broken_links.patch.gz 
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.

@loefflerd
Copy link
Mannequin Author

loefflerd mannequin commented Mar 27, 2012

Author: David Loeffler

@loefflerd loefflerd mannequin added the s: needs review label Mar 27, 2012
@aghitza
Copy link

aghitza commented Mar 27, 2012

comment:2

The warnings are gone. Looks good to me.

@aghitza
Copy link

aghitza commented Mar 27, 2012

Reviewer: Alex Ghitza

@loefflerd
Copy link
Mannequin Author

loefflerd mannequin commented Mar 28, 2012

comment:3

Thanks for the review!

@jdemeyer
Copy link

jdemeyer commented Apr 2, 2012

Merged: sage-5.0.beta12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants