Opened 6 years ago
Last modified 5 years ago
#14646 new enhancement
create a reference to SAGE_LOCAL/share/doc in docs
Reported by: | dimpase | Owned by: | mvngu |
---|---|---|---|
Priority: | major | Milestone: | sage-6.4 |
Component: | documentation | Keywords: | |
Cc: | vbraun, schilly, leif, mvngu, ppurka, kcrisman | Merged in: | |
Authors: | Reviewers: | ||
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description (last modified by )
currently the docs in SAGE_LOCAL/share/doc
are kind of lost to a casual user. We should advertise them in the main docs index.html
(which is made from doc/<LANG>/website/templates/index.html
).
As well, SAGE_LOCAL/share/doc
can have "fake" SPKGs documentation, forwarding to the respective internet location, which can be overwritten with a local installation if an spkg is installed with SAGE_SPKG_INSTALL_DOCS=yes
.
Change History (9)
comment:1 Changed 6 years ago by
- Description modified (diff)
comment:2 in reply to: ↑ description Changed 6 years ago by
- Cc ppurka added
comment:3 follow-up: ↓ 4 Changed 6 years ago by
We could run a script (after building, after the usual docbuilding, and/or from sage-location
) to collect top-level HTML pages below $SAGE_SHARE/doc/
and create an index file from those.
We could also create more symbolic links, e.g. $SAGE_SHARE/cvxopt/doc
-> $SAGE_SHARE/doc/cvxopt/...
.
comment:4 in reply to: ↑ 3 Changed 6 years ago by
Replying to leif:
We could run a script (after building, after the usual docbuilding, and/or from
sage-location
) to collect top-level HTML pages below$SAGE_SHARE/doc/
and create an index file from those.
Do you mean to say: create something to merge into the main index?
We could also create more symbolic links, e.g.
$SAGE_SHARE/cvxopt/doc
->$SAGE_SHARE/doc/cvxopt/...
.
This looks like creating more mess. I'd stick to $SAGE_SHARE/doc/
as the place where such docs should go to. Spkg's that use some other place should be fixed.
comment:5 Changed 6 years ago by
- Milestone changed from sage-5.11 to sage-5.12
comment:6 Changed 5 years ago by
- Milestone changed from sage-6.1 to sage-6.2
comment:7 Changed 5 years ago by
- Milestone changed from sage-6.2 to sage-6.3
comment:8 Changed 5 years ago by
- Milestone changed from sage-6.3 to sage-6.4
comment:9 Changed 5 years ago by
- Cc kcrisman added
Replying to dimpase:
a discussion that has led to this ticked happened on #14645.