Opened 8 years ago
Closed 4 years ago
#10908 closed enhancement (invalid)
Make SageTeX support SAGE_SPKG_INSTALL_DOCS
Reported by: | jason | Owned by: | tbd |
---|---|---|---|
Priority: | major | Milestone: | sage-duplicate/invalid/wontfix |
Component: | packages: standard | Keywords: | |
Cc: | ddrake | Merged in: | |
Authors: | Reviewers: | Dan Drake | |
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description
See #10823 for details about SAGE_SPKG_INSTALL_DOCS. We should build the docs fresh, which would be a nice test of if they had the necessary components to actually do SageTeX stuff.
Change History (15)
comment:1 follow-up: ↓ 2 Changed 8 years ago by
- Cc ddrake added
comment:2 in reply to: ↑ 1 ; follow-up: ↓ 4 Changed 8 years ago by
Replying to jason:
Also, it might be nice to distribute "tkz-graph.sty" and "tkz-berge.sty" with SageTeX, as the example file depends on it, I believe, and other nice features in Sage also depend on it.
That's a good idea, although of course you also need PGF/TikZ. Can we assume that anyone with a reasonable TeX setup has TikZ? Distributing tkz-graph and tkz-berge isn't too useful if lots of people don't even have TikZ.
comment:3 follow-up: ↓ 5 Changed 8 years ago by
Another thought: we could just try to build things, and if that doesn't work, just put a small file in the doc directory that points the user to https://bitbucket.org/ddrake/sagetex/downloads and the files there. That doesn't quite solve the problem Jason described at #10823 (being offline) but it does point in the right direction.
comment:4 in reply to: ↑ 2 Changed 8 years ago by
Replying to ddrake:
Replying to jason:
Also, it might be nice to distribute "tkz-graph.sty" and "tkz-berge.sty" with SageTeX, as the example file depends on it, I believe, and other nice features in Sage also depend on it.
That's a good idea, although of course you also need PGF/TikZ. Can we assume that anyone with a reasonable TeX setup has TikZ? Distributing tkz-graph and tkz-berge isn't too useful if lots of people don't even have TikZ.
I think *lots* of people do have tikz installed, but almost no one has tkz-graph.sty and tkz-berge.sty installed since you have to manually install it. Tikz seems like a pretty standard package on newer tex installs these days.
comment:5 in reply to: ↑ 3 Changed 8 years ago by
Replying to ddrake:
Another thought: we could just try to build things, and if that doesn't work, just put a small file in the doc directory that points the user to https://bitbucket.org/ddrake/sagetex/downloads and the files there. That doesn't quite solve the problem Jason described at #10823 (being offline) but it does point in the right direction.
That sounds like a good way to do things. Just check the error code after trying to build the docs.
comment:6 Changed 8 years ago by
- Status changed from new to needs_review
I have a spkg that supports SAGE_SPKG_INSTALL_DOCS: http://sage.math.washington.edu/home/drake/code/sage/st/sagetex-2.3.1.spkg. Please review.
I do have a question about what I did in spkg-install
: right now, when it tries to build the documentation and fails, it puts a file in the doc directory explaining the failure. But the installation fails. If someone is building Sage with SAGE_SPKG_INSTALL_DOCS set, the build will fail if the documentation can't be built -- so why put the file in the doc directory saying that it failed?
I have a couple ideas for what to do and would like some feedback:
- if building the docs fails, print the "you can download the pdfs" message to stdout, instead of putting it in a file -- then the user who is trying to build Sage can see how to correct the error.
- if building the docs fails, automatically try to download the docs using wget or curl -- and if that works, don't do the "exit 1" in spkg-install so the build can continue.
Thoughts?
comment:7 Changed 8 years ago by
- Status changed from needs_review to needs_work
See #11197 for building docs after Sage is built.
comment:8 Changed 6 years ago by
- Milestone changed from sage-5.11 to sage-5.12
comment:9 Changed 5 years ago by
- Milestone changed from sage-6.1 to sage-6.2
comment:10 Changed 5 years ago by
- Milestone changed from sage-6.2 to sage-6.3
comment:11 Changed 5 years ago by
- Milestone changed from sage-6.3 to sage-6.4
comment:12 Changed 4 years ago by
- Reviewers set to Dan Drake
- Status changed from needs_work to needs_review
I propose this ticket be closed, since SageTeX by default installs documentation into SAGE_ROOT/local/share/doc/sagetex/
.
comment:13 Changed 4 years ago by
- Milestone changed from sage-6.4 to sage-duplicate/invalid/wontfix
- Status changed from needs_review to positive_review
Setting to invalid/wontfix.
comment:14 Changed 4 years ago by
Just confirming that this makes sense.
comment:15 Changed 4 years ago by
- Resolution set to invalid
- Status changed from positive_review to closed
Also, it might be nice to distribute "tkz-graph.sty" and "tkz-berge.sty" with SageTeX, as the example file depends on it, I believe, and other nice features in Sage also depend on it.