Opened 6 years ago

Closed 6 years ago

#20030 closed enhancement (duplicate)

Change SAGE_DOC environment variables

Reported by: jdemeyer Owned by:
Priority: blocker Milestone: sage-duplicate/invalid/wontfix
Component: misc Keywords:
Cc: fbissey Merged in:
Authors: Jeroen Demeyer Reviewers: François Bissey
Report Upstream: N/A Work issues:
Branch: u/fbissey/SAGE_DOC_SRC (Commits, GitHub, GitLab) Commit: 56ea5ef6732e1ffa4036fdd90c8404f715e5df36
Dependencies: Stopgaps:

Status badges

Description (last modified by jdemeyer)

Replace SAGE_DOC -> SAGE_DOC_SRC SAGE_DOC_OUTPUT -> SAGE_DOC

Merge with #20047

Change History (21)

comment:1 Changed 6 years ago by jdemeyer

  • Dependencies set to #19963

comment:2 Changed 6 years ago by jdemeyer

  • Branch set to u/jdemeyer/SAGE_DOC_SRC

comment:3 Changed 6 years ago by jdemeyer

  • Commit set to f3d7236bf4363bc9aeb64fbe19e487da0b1914fb
  • Status changed from new to needs_review

New commits:

1cebbc9Fix citation dir with custom SAGE_DOC_OUTPUT
2c56897Build documentation in $SAGE_SHARE/doc/sage
dfe2c06Minor fixes to top-level build system
cb2b63fRemove old src/doc/ouput and .pyc files
a601a8cAdd symbolic link SAGE_DOC/output -> SAGE_DOC_OUTPUT
de10a5eUse new documentation paths in documentation
96685abFix a few more paths
f3d7236SAGE_DOC -> SAGE_DOC_SRC and SAGE_DOC_OUTPUT -> SAGE_DOC

comment:4 Changed 6 years ago by git

  • Commit changed from f3d7236bf4363bc9aeb64fbe19e487da0b1914fb to 16676356641ffd1468d560104f4df1f367d74fa4

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

1667635Ignore errors in symlinking

comment:5 Changed 6 years ago by fbissey

  • Reviewers set to François Bissey
  • Status changed from needs_review to positive_review

Looks good to me.

comment:6 Changed 6 years ago by vbraun

  • Status changed from positive_review to needs_work

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'

comment:7 Changed 6 years ago by fbissey

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 https://github.com/sagemath/sagenb/pull/363 in sagenb would be sufficient to fix the problem.

comment:8 Changed 6 years ago by fbissey

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.

comment:9 Changed 6 years ago by jdemeyer

Yes, I was also very surprised to see that.

comment:10 Changed 6 years ago by jdemeyer

  • Milestone changed from sage-7.1 to sage-pending
  • Status changed from needs_work to positive_review

comment:11 Changed 6 years ago by fbissey

  • Status changed from positive_review to needs_work

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

comment:12 Changed 6 years ago by fbissey

  • Branch changed from u/jdemeyer/SAGE_DOC_SRC to u/fbissey/SAGE_DOC_SRC
  • Commit changed from 16676356641ffd1468d560104f4df1f367d74fa4 to 56ea5ef6732e1ffa4036fdd90c8404f715e5df36

Corrected missing SAGE_DOC_SRC.


New commits:

56ea5efMissing a SAGE_DOC_SRC in sagedoc.py

comment:13 Changed 6 years ago by fbissey

  • Status changed from needs_work to positive_review

comment:14 Changed 6 years ago by fbissey

#20047 is for the matching change in sagenb.

comment:15 Changed 6 years ago by jdemeyer

  • Dependencies #19963 deleted
  • Description modified (diff)

comment:16 follow-up: Changed 6 years ago by vbraun

still pending?

comment:17 in reply to: ↑ 16 Changed 6 years ago by fbissey

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).

comment:18 Changed 6 years ago by jdemeyer

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

comment:19 Changed 6 years ago by vbraun

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).

comment:20 Changed 6 years ago by jdemeyer

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

comment:21 Changed 6 years ago by vbraun

  • Milestone changed from sage-pending to sage-duplicate/invalid/wontfix
  • Resolution set to duplicate
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.