Add quadratic forms code to the reference manual

[annahaensch]

Apply:

• attachment: trac_9383_v4.patch

Component: documentation

Author: Anna Haensch, David Loeffler

Reviewer: Minh Van Nguyen

Merged: sage-4.6.alpha2

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

[annahaensch]

Attachment: trac_9383.patch.gz

quadratic_forms reference manual docbuild

[annahaensch]

comment:1

This is half of the quadratic_forms documentation, I'll post the second half in an updated patch tomorrow.

[annahaensch]

Use instead of trac_9383.patch

[annahaensch]

comment:2

Attachment: trac_9383_v2.patch.gz

This patch should complete the reference documentation for quadratic forms. It's still returning a warning that the file is not contained in a toctree. Ideas?

[annahaensch]

Attachment: trac_9383_v3.patch.gz

Use in place of all previous patches

[loefflerd]

comment:3

It looks to me like you forgot to do "hg add" on your new file doc/en/reference/quadratic_forms.rst. Hence when I apply the patch to a new clone and build, I get an error
/storage/masiao/sage-4.5.2.alpha1/devel/sage/doc/en/reference/index.rst:40: (WARNING/2) toctree references unknown document u'quadratic_forms'
and nothing new appears in the ref manual.

David

[loefflerd]

comment:4

BTW: the reference manual building code can behave very oddly when files have been deleted -- because of the way that the Sphinx parser caches its environment, it's next to impossible to squash the "document not included in any toctree" error, except by creating a new clean clone and applying your patch to that.

[loefflerd]

Attachment: trac_9383_v4.patch.gz

replaces all previous patches

[loefflerd]

Changed author from Anna Haensch to Anna Haensch, David Loeffler

[loefflerd]

comment:6

Here's a new patch, against 4.5.2.rc0, incorporating Anna's work and extending it by adding the modules count_local_2 and special_values.

The results are a little scruffy in places, but that will be much easier to sort out once the modules have been added and people can see the results!

[sagetrac-mvngu]

Reviewer: Minh Van Nguyen

[sagetrac-mvngu]

comment:7

I'm OK with the attachment attachment: trac_9383_v4.patch. Note that it adds the following modules to the reference manual:

sage/quadratic_forms/quadratic_form 
sage/quadratic_forms/binary_qf 
sage/quadratic_forms/constructions 
sage/quadratic_forms/random_quadraticform 
sage/quadratic_forms/special_values 
sage/quadratic_forms/count_local_2

The attachment make numerous ReST changes to the following modules, but does not add them to the reference manual:

sage/quadratic_forms/quadratic_form__automorphisms.py
sage/quadratic_forms/quadratic_form__count_local_2.py
sage/quadratic_forms/quadratic_form__equivalence_testing.py
sage/quadratic_forms/quadratic_form__genus.py
sage/quadratic_forms/quadratic_form__local_density_congruence.py
sage/quadratic_forms/quadratic_form__local_density_interfaces.py
sage/quadratic_forms/quadratic_form__local_field_invariants.py
sage/quadratic_forms/quadratic_form__local_normal_form.py
sage/quadratic_forms/quadratic_form__local_representation_conditions.py
sage/quadratic_forms/quadratic_form__mass.py
sage/quadratic_forms/quadratic_form__mass__Conway_Sloane_masses.py
sage/quadratic_forms/quadratic_form__mass__Siegel_densities.py
sage/quadratic_forms/quadratic_form__neighbors.py
sage/quadratic_forms/quadratic_form__reduction_theory.py
sage/quadratic_forms/quadratic_form__siegel_product.py
sage/quadratic_forms/quadratic_form__split_local_covering.py
sage/quadratic_forms/quadratic_form__ternary_Tornaria.py
sage/quadratic_forms/quadratic_form__theta.py
sage/quadratic_forms/quadratic_form__variable_substitutions.py

The attachment: trac_9383_v4.patch receives a positive review as is. If you want, you could open another ticket to add the missing modules to the reference manual.

[loefflerd]

comment:8

Replying to @sagetrac-mvngu:

The attachment make numerous ReST changes to the following modules, but does not add them to the reference manual:

sage/quadratic_forms/quadratic_form__automorphisms.py
sage/quadratic_forms/quadratic_form__count_local_2.py
sage/quadratic_forms/quadratic_form__equivalence_testing.py
sage/quadratic_forms/quadratic_form__genus.py
sage/quadratic_forms/quadratic_form__local_density_congruence.py
sage/quadratic_forms/quadratic_form__local_density_interfaces.py
sage/quadratic_forms/quadratic_form__local_field_invariants.py
sage/quadratic_forms/quadratic_form__local_normal_form.py
sage/quadratic_forms/quadratic_form__local_representation_conditions.py
sage/quadratic_forms/quadratic_form__mass.py
sage/quadratic_forms/quadratic_form__mass__Conway_Sloane_masses.py
sage/quadratic_forms/quadratic_form__mass__Siegel_densities.py
sage/quadratic_forms/quadratic_form__neighbors.py
sage/quadratic_forms/quadratic_form__reduction_theory.py
sage/quadratic_forms/quadratic_form__siegel_product.py
sage/quadratic_forms/quadratic_form__split_local_covering.py
sage/quadratic_forms/quadratic_form__ternary_Tornaria.py
sage/quadratic_forms/quadratic_form__theta.py
sage/quadratic_forms/quadratic_form__variable_substitutions.py

The attachment: trac_9383_v4.patch receives a positive review as is. If you want, you could open another ticket to add the missing modules to the reference manual.

No, there is no need to do this. The functions from those modules are all imported into quadratic__form.py; they are divided into separate modules solely in order to keep the size of the top-level file manageable. The ReST parser follows these imports, so adding the separate files to the manual as well would just mean everything was in there twice.

Thanks for the review, anyway!

David

[qed777]

Merged: sage-4.6.alpha2