Skip to content

Commit 19b22eb

Browse files
authored
Run grunt (#522)
* Run Grunt Also fix some errors from recent docs rename * Upgade grunt contrib sass to 1.0.0 Fixes the following warning: ``` DEPRECATION WARNING: Passing --sourcemap without a value is deprecated. Sourcemaps are now generated by default, so this flag has no effect. ``` * Revert change to gitignore * Watch readme file
1 parent 9f84648 commit 19b22eb

File tree

8 files changed

+46
-46
lines changed

8 files changed

+46
-46
lines changed

Gruntfile.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ module.exports = function(grunt) {
1414
server: {
1515
options: {
1616
port: 1919,
17-
base: 'demo_docs/build',
17+
base: 'docs/build',
1818
livereload: true
1919
}
2020
}
@@ -117,11 +117,11 @@ module.exports = function(grunt) {
117117
cmd: 'bower update'
118118
},
119119
build_sphinx: {
120-
cmd: 'sphinx-build demo_docs/source demo_docs/build'
120+
cmd: 'sphinx-build docs/ docs/build'
121121
}
122122
},
123123
clean: {
124-
build: ["demo_docs/build"],
124+
build: ["docs/build"],
125125
fonts: ["sphinx_rtd_theme/static/fonts"],
126126
css: ["sphinx_rtd_theme/static/css"],
127127
js: ["sphinx_rtd_theme/static/js/*", "!sphinx_rtd_theme/static/js/modernizr.min.js"]
@@ -135,17 +135,17 @@ module.exports = function(grunt) {
135135
},
136136
/* Changes in theme dir rebuild sphinx */
137137
sphinx: {
138-
files: ['sphinx_rtd_theme/**/*', 'demo_docs/**/*.rst', 'demo_docs/**/*.py'],
138+
files: ['sphinx_rtd_theme/**/*', 'README.rst', 'docs/**/*.rst', 'docs/**/*.py'],
139139
tasks: ['clean:build','exec:build_sphinx']
140140
},
141141
/* JavaScript */
142142
browserify: {
143143
files: ['js/*.js'],
144144
tasks: ['browserify:dev']
145145
},
146-
/* live-reload the demo_docs if sphinx re-builds */
146+
/* live-reload the docs if sphinx re-builds */
147147
livereload: {
148-
files: ['demo_docs/build/**/*'],
148+
files: ['docs/build/**/*'],
149149
options: { livereload: true }
150150
}
151151
}

bower.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
],
1313
"ignore": [
1414
"docs",
15-
"demo_docs",
1615
".gitignore",
1716
".DS_Store",
1817
".sass-cache*",

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sphinx_rtd_theme",
3-
"version": "0.0.11",
3+
"version": "0.2.5b2",
44
"private": true,
55
"dependencies": {},
66
"devDependencies": {
@@ -11,7 +11,7 @@
1111
"grunt-contrib-clean": "^1.0.0",
1212
"grunt-contrib-connect": "^1.0.2",
1313
"grunt-contrib-copy": "~1.0.0",
14-
"grunt-contrib-sass": "~0.8.0",
14+
"grunt-contrib-sass": "~1.0.0",
1515
"grunt-contrib-watch": "~1.0.0",
1616
"grunt-exec": "~1.0.1",
1717
"grunt-open": "0.2.3",

sphinx_rtd_theme/static/css/badge_only.css

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sphinx_rtd_theme/static/css/badge_only.css.map

Lines changed: 0 additions & 7 deletions
This file was deleted.

sphinx_rtd_theme/static/css/theme.css

Lines changed: 2 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sphinx_rtd_theme/static/css/theme.css.map

Lines changed: 0 additions & 7 deletions
This file was deleted.

sphinx_rtd_theme/static/js/theme.js

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,22 @@ function ThemeNav () {
1616
isRunning: false
1717
};
1818

19-
nav.enable = function () {
19+
nav.enable = function (withStickyNav) {
2020
var self = this;
2121

22-
if (!self.isRunning) {
23-
self.isRunning = true;
24-
jQuery(function ($) {
25-
self.init($);
22+
if (self.isRunning) {
23+
// Only allow enabling nav logic once
24+
return;
25+
}
2626

27-
self.reset();
28-
self.win.on('hashchange', self.reset);
27+
self.isRunning = true;
28+
jQuery(function ($) {
29+
self.init($);
2930

31+
self.reset();
32+
self.win.on('hashchange', self.reset);
33+
34+
if (withStickyNav) {
3035
// Set scroll monitor
3136
self.win.on('scroll', function () {
3237
if (!self.linkScroll) {
@@ -36,18 +41,23 @@ function ThemeNav () {
3641
}
3742
}
3843
});
44+
}
3945

40-
// Set resize monitor
41-
self.win.on('resize', function () {
42-
if (!self.winResize) {
43-
self.winResize = true;
44-
requestAnimationFrame(function() { self.onResize(); });
45-
}
46-
});
47-
48-
self.onResize();
46+
// Set resize monitor
47+
self.win.on('resize', function () {
48+
if (!self.winResize) {
49+
self.winResize = true;
50+
requestAnimationFrame(function() { self.onResize(); });
51+
}
4952
});
50-
};
53+
54+
self.onResize();
55+
});
56+
57+
};
58+
59+
nav.enableSticky = function() {
60+
this.enable(true);
5161
};
5262

5363
nav.init = function ($) {
@@ -80,9 +90,16 @@ function ThemeNav () {
8090
})
8191

8292
// Make tables responsive
83-
$("table.docutils:not(.field-list)")
93+
$("table.docutils:not(.field-list,.footnote,.citation)")
8494
.wrap("<div class='wy-table-responsive'></div>");
8595

96+
// Add extra class to responsive tables that contain
97+
// footnotes or citations so that we can target them for styling
98+
$("table.docutils.footnote")
99+
.wrap("<div class='wy-table-responsive footnote'></div>");
100+
$("table.docutils.citation")
101+
.wrap("<div class='wy-table-responsive citation'></div>");
102+
86103
// Add expand links to all parents of nested ul
87104
$('.wy-menu-vertical ul').not('.simple').siblings('a').each(function () {
88105
var link = $(this);
@@ -170,7 +187,7 @@ function ThemeNav () {
170187
module.exports.ThemeNav = ThemeNav();
171188

172189
if (typeof(window) != 'undefined') {
173-
window.SphinxRtdTheme = { StickyNav: module.exports.ThemeNav };
190+
window.SphinxRtdTheme = { Navigation: module.exports.ThemeNav };
174191
}
175192

176193

0 commit comments

Comments
 (0)