#17498: Pictures in the doc through ".. plot::" directive
-------------------------------------+-------------------------------------
Reporter: ncohen | Owner:
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-6.5
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Nathann Cohen, | Reviewers: Nathann Cohen, John
John Palmieri | Palmieri
Report Upstream: N/A | Work issues:
Branch: public/17498 | Commit:
Dependencies: #17508 | 6e51751b533c42f10f18f00dc7a01b4dacf0aa43
| Stopgaps:
-------------------------------------+-------------------------------------
Comment (by tmonteil):
Replying to [comment:60 jhpalmieri]:
Thanks for your commit, now we can do
{{{
export SAGE_DOCBUILD_OPTS+=' --no-plot'
}}}
and continue in a usual workflow.
> Replying to [comment:57 tmonteil]:
> > Back to the main issue, John's current fix is a good step, but it does
not solve the fact that when we run `make` to build Sage, the doc is built
with pictures with no possibility to avoid it, and then we have to rebuild
the doc again to remove them.
>
> No, you just run `make doc-html-no-pix`: this builds Sage and then the
docs, but with no pictures.
My point was that many targets build docs and could not have plots turned
off, which will require rebuilding doc afterwards. For example it would
looks weird to add `make ptestlong-no-pix` target. Conversely, environment
variables can be combined, this somehow avoids quadratic explosion of make
targets.
> My goal wasn't to introduce an environment variable for the user to set,
which is why I didn't document it in the installation guide. This style
is common throughout `builder.py`. Various people have suggested, and I
agree, that Sage has too many environment variables as it is, and we
should instead control behavior using command-line flags, Makefile
targets, etc. In this case, the environment variable (for internal use
only) is a useful way to pass the information around.
OK. So let us let the `SAGE_SKIP_PLOT_DIRECTIVE` undocumented for now and
consider it internal only.
> > - Instead of adding a new `html-no-pix` FORMAT for the docbuild
command, it could be better to add a `--no-pix` OPTION (or perhaps `--no-
plot` ?). See `sage -docbuild` for the documentation. This is more
consistent with the existing `--no-pdf-links` or `--no-colors` options,
but also allows to pass the `--no-pix` (or whatever) option in the
Makefile calls via the `SAGE_DOCBUILD_OPTS` command.
>
> This sounds like a good idea. Shouldn't be hard to do. See the new
commit.
Thanks, it works well. And it solves the previous possible issue with make
targets.
--
Ticket URL: <http://trac.sagemath.org/ticket/17498#comment:61>
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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
