Add matrix/matrix_double_dense.py to documentation

[rbeezer]

The source file matrix/matrix_double_dense.py is not included in the documentation. It appears that it should be, since it has functions that are of interest to users. Patch simply adds it to the right place in the documentation tree.

The file itself needs some love. After #4756 goes in, the following four functions should be in good shape. The remainder needs work.

left_eigenvectors()
right_eigenvectors()
eigenspaces_left()
eigenspaces_right()

---

Apply attachment: trac_8046_matrix_double_dense.patch and attachment: trac_8046-ref.patch.

Component: documentation

Keywords: beginner sd35.5

Author: Kenneth Smith, John Palmieri

Reviewer: John Palmieri, Karl-Dieter Crisman

Merged: sage-5.0.beta1

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

[jasongrout]

comment:1

Attachment: trac_8046_matrix_double_doc_add.patch.gz

I get some errors on 4.6.1 when building the docs:

docstring of sage.matrix.matrix_double_dense.Matrix_double_dense.condition:11: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.
docstring of sage.matrix.matrix_double_dense:7: (ERROR/3) Unexpected indentation.
docstring of sage.matrix.matrix_double_dense.Matrix_double_dense.numpy:11: (WARNING/2) Block quote ends without a blank line; unexpected unindent.
docstring of sage.matrix.matrix_double_dense:13: (ERROR/3) Unexpected indentation.
docstring of sage.matrix.matrix_double_dense:13: (ERROR/3) Unexpected indentation.
<autodoc>:0: (ERROR/3) Unexpected indentation.

[rbeezer]

comment:2

Replying to @jasongrout:

Yes, the file "needs_work". I went through it a couple days ago and cleaned up lots of little things (documentation mostly), but then went off and made a few patches with code changes. I'll get back to it very soon and insert into the other work I'm doing.

[kcrisman]

Changed keywords from none to beginner sd35.5

[sagetrac-ksmith]

comment:4

I made a new patch. This one includes the matrix double dense to the documentation like the last one, and it also edits the file a lot to get rid of almost all of the syntax errors. I am still getting 2 warnings however:

One is:

docstring of sage.matrix.matrix_double_dense:8: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.

I cannot, however find what the error message is talking about, even after multiple people examined it for quite a while.

The other one is:

WARNING: dvipng command 'dvipng' cannot be run (needed for math display), check the pngmath_dvipng setting

which I am told can be ignored.

So really there is just one warning that could still be fixed.

[sagetrac-ksmith]

Author: Kenneth Smith

[jhpalmieri]

comment:5

Attachment: trac_8046_matrix_double_dense.patch.gz

I'm attaching a 'referee' patch to fix up some docstrings. The first change in that patch fixes the warning message about the unexpected unindent; the others just tidy some things up.

[jhpalmieri]

Attachment: trac_8046-ref.patch.gz

[kcrisman]

Changed author from Kenneth Smith to Kenneth Smith, John Palmieri

[kcrisman]

comment:7

Looks great! Thanks for catching this, John.

[kcrisman]

Reviewer: John Palmieri, Karl-Dieter Crisman, Jason Grout, Jeroen Demeyer, Steven Trogdon, Leif Leonhardy, Sébastien Labbé

[jasongrout]

comment:8

If you build the documentation with "-j", it will use jsmath, and should not give the error about dvipng: sage -docbuild reference html -j

[kcrisman]

comment:9

If you build the documentation with "-j", it will use jsmath, and should not give the error about dvipng: sage -docbuild reference html -j

Interesting. In any case, that was clearly an unrelated error.

[kcrisman]

Changed reviewer from John Palmieri, Karl-Dieter Crisman, Jason Grout, Jeroen Demeyer, Steven Trogdon, Leif Leonhardy, Sébastien Labbé to John Palmieri, Karl-Dieter Crisman

[jdemeyer]

Merged: sage-5.0.beta1