Opened 12 years ago

Closed 12 years ago

#8102 closed enhancement (fixed)

Simplify Sphinxify

Reported by: mpatel Owned by: was
Priority: minor Milestone: sage-4.3.2
Component: notebook Keywords:
Cc: timdumol Merged in: sagenb-0.7.4
Authors: Mitesh Patel Reviewers: John Palmieri
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

Simplifying sagenb.misc.sphinxify and importing sphinx.application.Sphinx on demand should make docstrings render faster and reduce Sage startup time.

Attachments (2)

trac_8102-simplify_sphinxify.patch (7.2 KB) - added by mpatel 12 years ago.
Simplify sphinxify.py. Some pep8 tweaks. sagenb repo.
trac_8102-simplify_sphinxify.2.patch (7.3 KB) - added by mpatel 12 years ago.
Replace SAGE_DOC = None with SAGE_DOC = ''. Replaces previous.

Download all attachments as: .zip

Change History (8)

Changed 12 years ago by mpatel

Simplify sphinxify.py. Some pep8 tweaks. sagenb repo.

comment:1 Changed 12 years ago by mpatel

  • Status changed from new to needs_review

The patch also includes some pep8 tweaks.

comment:2 Changed 12 years ago by mpatel

Specifically,

/usr/bin/pep8 --repeat --show-source --ignore=E251,E301,E302,E501 sphinxify.py

And to test the startup imports / time: sage -startuptime

comment:3 Changed 12 years ago by jhpalmieri

In line 89

confdir = os.path.join(SAGE_DOC, 'en', 'introspect') 

won't there be problems if SAGE_DOC is None? I guess earlier in the file, you could change the last line in the following:

try:
    from sage.misc.misc import SAGE_DOC
except ImportError:
    SAGE_DOC = ""  # used to be None

Otherwise it looks good.

Changed 12 years ago by mpatel

Replace SAGE_DOC = None with SAGE_DOC = ''. Replaces previous.

comment:4 Changed 12 years ago by mpatel

Thanks for catching that exception. V2 includes the change.

comment:5 Changed 12 years ago by jhpalmieri

  • Reviewers set to John Palmieri
  • Status changed from needs_review to positive_review

comment:6 Changed 12 years ago by mpatel

  • Merged in set to sagenb-0.7.4
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.