Change SAGE_DOC environment variables

[jdemeyer]

Replace
SAGE_DOC -> SAGE_DOC_SRC
SAGE_DOC_OUTPUT -> SAGE_DOC

Merge with #20047

CC: @kiwifb

Component: misc

Author: Jeroen Demeyer

Branch/Commit: u/fbissey/SAGE_DOC_SRC @ 56ea5ef

Reviewer: François Bissey

Issue created by migration from https://trac.sagemath.org/ticket/20030

[jdemeyer]

Dependencies: #19963

[jdemeyer]

Branch: u/jdemeyer/SAGE_DOC_SRC

[jdemeyer]

Commit: f3d7236

[jdemeyer]

New commits:

1cebbc9	Fix citation dir with custom SAGE_DOC_OUTPUT
2c56897	Build documentation in $SAGE_SHARE/doc/sage
dfe2c06	Minor fixes to top-level build system
cb2b63f	Remove old src/doc/ouput and .pyc files
a601a8c	Add symbolic link SAGE_DOC/output -> SAGE_DOC_OUTPUT
de10a5e	Use new documentation paths in documentation
96685ab	Fix a few more paths
f3d7236	SAGE_DOC -> SAGE_DOC_SRC and SAGE_DOC_OUTPUT -> SAGE_DOC

[sagetrac-git]

Changed commit from f3d7236 to 1667635

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

1667635

Ignore errors in symlinking

[kiwifb]

Reviewer: François Bissey

[kiwifb]

comment:5

Looks good to me.

[vbraun]

comment:6

Breaks incremental updates

File "src/sage/misc/sageinspect.py", line 25, in sage.misc.sageinspect
Failed example:
    sage_getdoc(sage.rings.rational).lstrip()
Exception raised:
    Traceback (most recent call last):
      File "/home/buildslave-sage/slave/sage_git/build/local/lib/python2.7/site-packages/sage/doctest/forker.py", line 496, in _run
        self.compile_and_execute(example, compiler, test.globs)
      File "/home/buildslave-sage/slave/sage_git/build/local/lib/python2.7/site-packages/sage/doctest/forker.py", line 858, in compile_and_execute
        exec(compiled, globs)
      File "<doctest sage.misc.sageinspect[2]>", line 1, in <module>
        sage_getdoc(sage.rings.rational).lstrip()
      File "/home/buildslave-sage/slave/sage_git/build/local/lib/python2.7/site-packages/sage/misc/sageinspect.py", line 1829, in sage_getdoc
        s = sage.misc.sagedoc.format(r, embedded=(embedded_override or EMBEDDED_MODE))
      File "/home/buildslave-sage/slave/sage_git/build/local/lib/python2.7/site-packages/sage/misc/sagedoc.py", line 664, in format
        s = detex(s, embedded=embedded)
      File "/home/buildslave-sage/slave/sage_git/build/local/lib/python2.7/site-packages/sage/misc/sagedoc.py", line 219, in detex
        s = sphinxify(s, format='text')
      File "/home/buildslave-sage/slave/sage_git/build/local/lib/python2.7/site-packages/sagenb-0.11.6.1-py2.7.egg/sagenb/misc/sphinxify.py", line 121, in sphinxify
        confoverrides, None, None, True)
      File "/home/buildslave-sage/slave/sage_git/build/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/application.py", line 107, in __init__
        confoverrides or {}, self.tags)
      File "/home/buildslave-sage/slave/sage_git/build/local/lib/python2.7/site-packages/Sphinx-1.2.2-py2.7.egg/sphinx/config.py", line 227, in __init__
        os.chdir(dirname)
    OSError: [Errno 2] No such file or directory: '/home/buildslave-sage/slave/sage_git/build/local/share/doc/sage/en/introspect'

[kiwifb]

comment:7

Yes I have now noticed in the last hour that this change would require to have at least en/introspect/conf.py and common/conf.py in the doc folder, shipped under the new SAGE_DOC. Alternatively the function generate_configuration in the sage notebook at sagenb/misc/sphinxify.py needs to be fixed. I would be quite eager for it to be.

However including sagemath/sagenb#363 in sagenb would be sufficient to fix the problem.

[kiwifb]

comment:8

Why is sphinxify.py part of sagenb rather than sage? I think the functionality should be moved in the future, especially if we want to deprecate sagenb.

[jdemeyer]

comment:9

Yes, I was also very surprised to see that.

[kiwifb]

comment:11

Found one error, line 804 of sagedoc.py needs to be changed from SAGE_DOC to SAGE_DOC_SRC.

[kiwifb]

comment:12

Corrected missing SAGE_DOC_SRC.

---

New commits:

56ea5ef

Missing a SAGE_DOC_SRC in sagedoc.py

[kiwifb]

Changed branch from u/jdemeyer/SAGE_DOC_SRC to u/fbissey/SAGE_DOC_SRC

[kiwifb]

Changed commit from 1667635 to 56ea5ef

[kiwifb]

comment:14

#20047 is for the matching change in sagenb.

[jdemeyer]

Changed dependencies from #19963 to none

[vbraun]

comment:16

still pending?

[kiwifb]

comment:17

Replying to @vbraun:

still pending?

Slight problems in #20047, the new sagenb tarball is not ready, it should have included a new dependency (or sticked to the old ones).

[jdemeyer]

comment:18

This should be merged through #20047, which contains the branch here. Not sure which milestone I should set then.

[vbraun]

comment:19

If this ticket can't be merged alone and can't depend on #20047 (because it is contained there) then it should be closed. Alternatively make this ticket depend on #20047 which will result in an trivial merge commit (adding no new code).

[jdemeyer]

comment:20

OK, then you can just close this ticket when you merge #20047.