Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support bootswatch while offline (no CDN) #19

Closed
zyga opened this issue Mar 31, 2013 · 7 comments
Closed

Support bootswatch while offline (no CDN) #19

zyga opened this issue Mar 31, 2013 · 7 comments
Labels

Comments

@zyga
Copy link
Contributor

zyga commented Mar 31, 2013

This ticket is meant to start a dicussion on how to support bootswatch while offline. My goal is to get fully offline bootswatch theme so that those could be used in Debian/Ubuntu for certain documentation builds.

For Debian packages, depending on the CDN would be inappropriate.

There are a few factors to consider:

  1. How to track upstream bootswatch code:
  • Do we copy each release?
  • Do we use submodule and track the version to bundle?
  1. How do we release sphinx-bootstrap-theme?

  2. How to select offline vs CND.

My suggestions are to:

  1. Use a git submodule
  2. Craft appropriate MANIFEST.in and setup.py settings to release both normal and minified css and javascript
  3. Use a new theme: "cdn" defaulting to False
@ryan-roemer
Copy link
Owner

Actually, if we want to go this route, it's probably easier to just remove CDN option and host all of the static Bootswatch files directly. This is what is done with Bootstrap directly, and it hasn't been too bad so far (plus, I have to manually patch the .js files to use a special them noConflict version of jQuery). And, we can conveniently avoid that "include vanilla and bootswatch CSS files" issue in the current approach.

As for maintaining versions, we can probably script an upgrade to all the relevant Bootswatch (*.css, *.min.css) files in the Fabric files to make for easy upgrades.

My main goal with this thinking is Python packaging is way simpler with this, and it hasn't been bad for Bootstrap / jQuery so far this way.

@zyga
Copy link
Contributor Author

zyga commented Apr 3, 2013

I think both CDN and offline have their uses, for things like readthedocs it would make sense to use the CDN variant, in the system ${library}-doc packages I would probably not use the CDN variant to make everything function offline (after all, that's the whole point of having a -doc packages)

@russell russell mentioned this issue Sep 3, 2013
@pcav
Copy link

pcav commented Nov 4, 2013

I think adding an option to copy everything locally would be a good step forward, and should not be complicated.
Am I wrong?

@pcav
Copy link

pcav commented Nov 14, 2013

Any advance on this?

@zyga
Copy link
Contributor Author

zyga commented Nov 16, 2013

I don't have time to work on this ATM, sorry.

@ryan-roemer
Copy link
Owner

Implemented.

@ryan-roemer
Copy link
Owner

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants