#11251: Add todo extension to Sphinx
-----------------------------+----------------------------------------------
Reporter: hivert | Owner: hivert
Type: enhancement | Status: positive_review
Priority: major | Milestone: sage-4.7.2
Component: documentation | Keywords: todo sphinx days30
Work_issues: | Upstream: N/A
Reviewer: John Palmieri | Author: Florent Hivert
Merged: | Dependencies:
-----------------------------+----------------------------------------------
Comment(by hivert):
Replying to [comment:19 leif]:
> Maybe I misunderstood the intent, but is there a way to omit the TODOs
from
> "production" documentation?
> (I thought they were only for "internal" use, i.e. invisible to an
> "ordinary" user, as opposed to a developer working on the documentation,
> similar to `\note{}` of LaTeX's "beamer" class.)
Actually, this wasn't my intend. As an open source project, I don't see
the
point in hiding places where sage could be improved. On the contrary,
marking
clearly in the documentation: "there is something we want to improve here"
seems to me to be a good practice. This was my main motivation for adding
this
extension.
Otherwise said, in my mind those TODOs are more for long term improvement
where we don't know yet what to do and some feedback is needed or where we
don't have yet the manpower to do it, But my point of view is maybe not
shared
by the majority of sage developers/users.
Now to answer the technical question, in {{{doc/common/conf.py}}} you have
{{{
# include the todos
todo_include_todos = True
}}}
Changing it to {{{False}}} by hand or depending on an environment variable
should do the job. Still, I'd rather having it to True by default.
Florent
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11251#comment:20>
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.
