I'm working on #9128 whose goal is to resolve dangling links by looking in
python docs and in sage.all. On the way, I noticed that there are lots of
todos in the doc but no systematic way to handle them in sage. Fortunately,
there is a nice sphinx extension to handle them and gather them in a nice todo
list. I just created #11251 "Add todo extension to Sphinx" which allows to
use it as e.g.:
.. todo:: Should be optimized using Cython
Is there any objection to use it ?
At this point, I changed one todo as an example but did not systematically
change all the todos to avoid conflicts: the parts of sage bearing most todos
are those most likely to be under heavy development. Besides I didn't have the
time to do it ;-). I think it will be easier to instead change those
progressively, after a test period.
Do you agree with this approach?
Cheers,
Florent
Hi there,I'm working on #9128 whose goal is to resolve dangling links by looking in
python docs and in sage.all. On the way, I noticed that there are lots of
todos in the doc but no systematic way to handle them in sage. Fortunately,
there is a nice sphinx extension to handle them and gather them in a nice todo
list. I just created #11251 "Add todo extension to Sphinx" which allows to
use it as e.g.:.. todo:: Should be optimized using Cython
Is there any objection to use it ?
At this point, I changed one todo as an example but did not systematically
change all the todos to avoid conflicts: the parts of sage bearing most todos
are those most likely to be under heavy development. Besides I didn't have the
time to do it ;-). I think it will be easier to instead change those
progressively, after a test period.Do you agree with this approach?
Good idea. Done.
Florent
In the same veins, I think that links to trac ticket should be
hyperlinks. Sphinx extlinks extension make it very easy. The only question is
the syntax. I'm thinking about something like :ticket:`3412` or :trac:`2132`.
Any preferences or objections ?
Cheers,
Florent
Pablo
> --
> To post to this group, send an email to sage-...@googlegroups.com
> To unsubscribe from this group, send an email to
> sage-devel+...@googlegroups.com
> For more options, visit this group at
> http://groups.google.com/group/sage-devel
> URL: http://www.sagemath.org
>