Export to GitHub

sympy - issue #2780

``See Also`` feature in Matrices


Posted on Oct 24, 2011 by Massive Giraffe

Edit the doc-string to add list of other function that are closely related to the query.

This is the list of .py files which contains the functions.

sympy/matrices.py

There are around 69 functions which one needs to understand (the input parameters and final result and not the code) to interrelate them.

Comment #1

Posted on Oct 25, 2011 by Happy Elephant

For the see also section, if you format it as

See Also

:class:someclass, :function:somefunction

(use class or function depending on what that object actually is), then Sphinx will convert into a nice see also block. See for example the very bottom of http://docs.sympy.org/0.7.1/modules/galgebra/GA/GAsympy.html.

Comment #2

Posted on Oct 25, 2011 by Grumpy Cat

(No comment was entered for this change.)

Comment #3

Posted on Oct 30, 2011 by Happy Elephant

(No comment was entered for this change.)

Comment #4

Posted on Nov 9, 2011 by Happy Elephant

(No comment was entered for this change.)

Comment #5

Posted on Nov 20, 2011 by Happy Elephant

(No comment was entered for this change.)

Comment #6

Posted on Nov 24, 2011 by Happy Elephant

As noted at https://github.com/sympy/sympy/pull/747, the way to make this work with Sphinx is to just type the function name for functions, and do class:classname for classes. So something like

See Also

functionname: description class:classname: description

or you can just list the functions, classes without descriptions:

See Also

functionname1, functionname2, class:classname1, class:classname2

(though, obviously, putting the descriptions is better).

Comment #7

Posted on Nov 24, 2011 by Happy Elephant

(No comment was entered for this change.)

Comment #8

Posted on Mar 20, 2012 by Happy Elephant

(No comment was entered for this change.)

Comment #9

Posted on Sep 25, 2012 by Happy Giraffe

That was https://github.com/sympy/sympy/commit/ee6d6f057201e3ae30b1933b6ba3aa701255b339

Comment #10

Posted on Mar 5, 2014 by Happy Elephant

We have moved issues to GitHub https://github.com/sympy/sympy/issues.

Comment #11

Posted on Apr 6, 2014 by Happy Rabbit

Migrated to http://github.com/sympy/sympy/issues/5879

Status: Fixed

Labels:
Type-Enhancement Priority-Medium CodeInCategory-Documentation CodeInDifficulty-Easy EasyToFix CodeInImportedIntoMelange Matrices Restrict-AddIssueComment-Commit