#7813: No empty links at docs
----------------------------+-----------------------------------------------
Reporter: slosoi | Owner: schilly
Type: enhancement | Status: new
Priority: major | Milestone: sage-wishlist
Component: website/wiki | Keywords: docs
Work_issues: | Author: Sami Losoi
Upstream: N/A | Reviewer:
Merged: |
----------------------------+-----------------------------------------------
Description changed by slosoi:
Old description:
> To disable at least temporarily the dead links, for instance, at
>
> 1. http://sagemath.org/doc/genindex.html
> 2. http://sagemath.org/doc/tutorial/modindex.html
> 3. http://sagemath.org/doc/tutorial/genindex.html
> ...
>
> The ticket is based on the decision to improve Sage's docs at [http://www
> .mail-archive.com/[email protected]/msg33505.html].
>
> The next step is to show Sage developers how to add words to index
> similarly as Python -project does by the given syntax such as
>
> {{{
> .. index:: pair: file; byte-code
> }}}
>
> I propose to add a notice about that to Sage's developer manual and to
> change the command {{{ sage -coverage }} to reflect the need of the
> index. The manual should also show by examples which words are suitable
> to the index.
>
> I would like to have function names in the index such as uniquely at {{{
> sage -grep "def [a-zA-Z]*(" }}}.
>
>
> In other words, it would be great to have a notice like `Please, consider
> new keywords to index by adding ".. index:: keyword;"` above the keyword.
New description:
To disable at least temporarily the dead links, for instance, at
1. http://sagemath.org/doc/genindex.html
2. http://sagemath.org/doc/tutorial/modindex.html
3. http://sagemath.org/doc/tutorial/genindex.html
...
The ticket is based on the decision to improve Sage's docs at [http://www
.mail-archive.com/[email protected]/msg33505.html].
The next step is to show Sage developers how to add words to index
similarly as Python -project does by the given syntax such as
{{{
.. index:: pair: file; byte-code
}}}
I propose to add a notice about that to Sage's developer manual and to
change the command {{{ sage -coverage }} to reflect the need of the index.
The manual should also show by examples which words are suitable to the
index.
I would like to have function names in the index given for instance by
{{{ sage -grep "def [a-zA-Z]*(" }}}
In other words, it would be great to have a notice like `Please, consider
new keywords to index by adding ".. index:: keyword;"` above the keyword.
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/7813#comment:2>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
