Use templates for CSS

[TimDumol]

CSS is currently served by css() in css.py, even though it is completely static. Using templates for it should make things easier to customize in the future.

Component: notebook

Keywords: notebook css stylesheets

Author: Tim Dumol

Reviewer: Mitesh Patel, Jason Grout

Merged: Sage 4.1.2.alpha4

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

[TimDumol]

Moved CSS in css.py to templates, and adjusted twist.py to use them.

[TimDumol]

Author: Tim Dumol

[TimDumol]

comment:1

Attachment: trac_6865-templates-css.patch.gz

[jasongrout]

comment:2

This probably needs to be rebased after #6939 to include the CSS fix there (or the rebasing should go the other way, if this gets reviewed before that gets merged...)

[jasongrout]

comment:3

#6940 is a dup of this ticket (i.e., close #6940).

[qed777]

comment:4

Does the patch depend on another ticket's patch? Applying attachment: trac_6865-templates-css.patch to 4.1.2.alpha1, I get

applying trac_6865-templates-css.patch
patching file sage/server/notebook/css.py
Hunk #1 FAILED at 0
1 out of 3 hunks FAILED -- saving rejects to file sage/server/notebook/css.py.rej
patching file sage/server/notebook/twist.py
Hunk #1 FAILED at 133
Hunk #2 succeeded at 1787 with fuzz 1 (offset 37 lines).
Hunk #3 FAILED at 2315
2 out of 3 hunks FAILED -- saving rejects to file sage/server/notebook/twist.py.rej
patch failed, unable to continue (try -v)
patch failed, rejects left in working dir
errors during apply, please fix and refresh trac_6865-templates-css.patch

The important one is the last, which doesn't apply because the local twist.py contains

        elif self.problem == 'suspended':
            return HTMLResponse(stream = message("Your account is currently suspended."))

But I could have altered my configuration.

[qed777]

comment:5

I think we need to add

include sage/server/notebook/css/*

to MANIFEST.in, or we'll definitely hear from the release manager...

[jasongrout]

comment:6

What is MANIFEST.in and when do we need to add things to it?

[jasongrout]

comment:7

(setting to "needs work", based on mpatel's comment about MANIFEST.in and his comment about applying the patch)

[qed777]

comment:8

Replying to @jasongrout:

What is MANIFEST.in and when do we need to add things to it?

I believe the sage -bdist and sage -sdist invoke distutils to build sage-*.spkg. Distutils uses SAGE_ROOT/devel/sage/MANIFEST.in to determine which files to include in the distribution. If we add files to the local Mercurial repository, we should check that some line(s) in MANIFEST.in includes the newly tracked files or add a new line. Otherwise, the next (pre-)release of Sage will not include them. As mvngu puts it, this results in "repository corruption".

Previous sightings: #4460, #5653, #5799, #6568, etc.

[TimDumol]

comment:9

No, this doesn't depend on other patches. It is based on 4.1.2.alpha1.

I've made the requisite changes to MANIFEST.in.

[TimDumol]

Moved CSS in css.py to templates, and adjusted twist.py to use them. Rev 2. Apply this patch only.

[qed777]

Attachment: trac_6865-templates-css.2.patch.gz

Attachment: trac_6865-templates-css.3.patch.gz

Moved CSS in css.py to templates, and adjusted twist.py to use them. Rev 3. Apply this patch only.

[qed777]

comment:10

Changes in patch v3:

• css.py: if os.path.exists(user_css): --> if os.path.exists(user_css_path):
• css.py: + --> os.path.join()
• css.py: html -> HTML in docstring
• main.css: {% -> {%-

Sorry about the trivial stuff. I just noticed the whitespace control part of the Jinja2 docs.

This is a positive review from me, but someone should review my changes.

[jasongrout]

comment:11

Your changes look good to me.

[sagetrac-mvngu]

Merged: Sage 4.1.2.alpha3

[sagetrac-mvngu]

Reviewer: Mitesh Patel, Jason Grout

[sagetrac-mvngu]

comment:13

Merged trac_6865-templates-css.3.patch.

[sagetrac-mvngu]

comment:14

There is no 4.1.2.alpha3. Sage 4.1.2.alpha3 was William Stein's release for working on the making the notebook a standalone package.

[sagetrac-mvngu]

Changed merged from Sage 4.1.2.alpha3 to Sage 4.1.2.alpha4