diff --git a/Gruntfile.js b/Gruntfile.js index cbbfd7b8..9ca0ce09 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -14,7 +14,7 @@ module.exports = function(grunt) { server: { options: { port: 1919, - base: 'demo_docs/build', + base: 'docs/build', livereload: true } } @@ -117,12 +117,14 @@ module.exports = function(grunt) { cmd: 'bower update' }, build_sphinx: { - cmd: 'sphinx-build demo_docs/source demo_docs/build' + cmd: 'sphinx-build docs/ docs/build' } }, clean: { - build: ["demo_docs/build"], - fonts: ["sphinx_rtd_theme/static/fonts"] + build: ["docs/build"], + fonts: ["sphinx_rtd_theme/static/fonts"], + css: ["sphinx_rtd_theme/static/css"], + js: ["sphinx_rtd_theme/static/js/*", "!sphinx_rtd_theme/static/js/modernizr.min.js"] }, watch: { @@ -133,7 +135,7 @@ module.exports = function(grunt) { }, /* Changes in theme dir rebuild sphinx */ sphinx: { - files: ['sphinx_rtd_theme/**/*', 'demo_docs/**/*.rst', 'demo_docs/**/*.py'], + files: ['sphinx_rtd_theme/**/*', 'README.rst', 'docs/**/*.rst', 'docs/**/*.py'], tasks: ['clean:build','exec:build_sphinx'] }, /* JavaScript */ @@ -141,9 +143,9 @@ module.exports = function(grunt) { files: ['js/*.js'], tasks: ['browserify:dev'] }, - /* live-reload the demo_docs if sphinx re-builds */ + /* live-reload the docs if sphinx re-builds */ livereload: { - files: ['demo_docs/build/**/*'], + files: ['docs/build/**/*'], options: { livereload: true } } } @@ -159,7 +161,6 @@ module.exports = function(grunt) { grunt.loadNpmTasks('grunt-open'); grunt.loadNpmTasks('grunt-browserify'); - grunt.registerTask('fonts', ['clean:fonts','copy:fonts']); - grunt.registerTask('default', ['exec:bower_update','clean:build','sass:dev','browserify:dev','exec:build_sphinx','connect','open','watch']); - grunt.registerTask('build', ['exec:bower_update','clean:build','sass:build','browserify:build','exec:build_sphinx']); + grunt.registerTask('default', ['exec:bower_update','clean','copy:fonts','sass:dev','browserify:dev','exec:build_sphinx','connect','open','watch']); + grunt.registerTask('build', ['exec:bower_update','clean','copy:fonts','sass:build','browserify:build','exec:build_sphinx']); } diff --git a/bower.json b/bower.json index c0c8cd99..8bf7fe06 100644 --- a/bower.json +++ b/bower.json @@ -12,7 +12,6 @@ ], "ignore": [ "docs", - "demo_docs", ".gitignore", ".DS_Store", ".sass-cache*", diff --git a/docs/Makefile b/docs/Makefile index 1d570829..90e84f77 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -17,4 +17,4 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py index 67824eee..fc97c3d7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,8 +39,8 @@ extensions = [ 'sphinxcontrib.httpdomain', ] -# Math -mathjax_path = "http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" +# Do not warn about external images (status badges in README.rst) +suppress_warnings = ['image.nonlocal_uri'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -96,7 +96,7 @@ exclude_patterns = [] #show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'default' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..7283b7d1 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,38 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=python -msphinx +) +set SPHINXOPTS= +set SPHINXBUILD=sphinx-build +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=ReadtheDocsSphinxTheme + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The Sphinx module was not found. Make sure you have Sphinx installed, + echo.then set the SPHINXBUILD environment variable to point to the full + echo.path of the 'sphinx-build' executable. Alternatively you may add the + echo.Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/package.json b/package.json index 0f198ceb..03f08f91 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sphinx_rtd_theme", - "version": "0.0.11", + "version": "0.2.5b2", "private": true, "dependencies": {}, "devDependencies": { @@ -11,7 +11,7 @@ "grunt-contrib-clean": "^1.0.0", "grunt-contrib-connect": "^1.0.2", "grunt-contrib-copy": "~1.0.0", - "grunt-contrib-sass": "~0.8.0", + "grunt-contrib-sass": "~1.0.0", "grunt-contrib-watch": "~1.0.0", "grunt-exec": "~1.0.1", "grunt-open": "0.2.3", diff --git a/sass/_theme_layout.sass b/sass/_theme_layout.sass index 10b44443..895c8537 100644 --- a/sass/_theme_layout.sass +++ b/sass/_theme_layout.sass @@ -247,9 +247,7 @@ .wy-body-for-nav - background: left repeat-y $section-background-color - background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxOERBMTRGRDBFMUUxMUUzODUwMkJCOThDMEVFNURFMCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxOERBMTRGRTBFMUUxMUUzODUwMkJCOThDMEVFNURFMCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjE4REExNEZCMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjE4REExNEZDMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+EwrlwAAAAA5JREFUeNpiMDU0BAgwAAE2AJgB9BnaAAAAAElFTkSuQmCC) - background-size: $nav-desktop-width 1px + background: $section-background-color .wy-grid-for-nav position: absolute diff --git a/sass/_theme_rst.sass b/sass/_theme_rst.sass index a2035c51..924990b3 100644 --- a/sass/_theme_rst.sass +++ b/sass/_theme_rst.sass @@ -19,9 +19,6 @@ max-width: 100% height: auto - .highlight > pre, .linenodiv > pre - line-height: normal - div.figure margin-bottom: $base-line-height p.caption @@ -53,8 +50,39 @@ margin-left: $base-line-height line-height: $base-line-height margin-bottom: $base-line-height - .literal-block, pre.literal-block - @extend .codeblock + + pre.literal-block, div[class^='highlight'] + border: 1px solid $table-border-color + padding: 0px + overflow-x: auto + // 1px hack otherwise border won't show. lame + margin: 1px 0 $base-line-height 0 + div[class^='highlight'] + border: none + margin: 0 + // Needs 100% width for line highlighting to work properly + div[class^='highlight'] td.code + width: 100% + .linenodiv pre + border-right: solid 1px lighten($table-border-color, 2%) + margin: 0 + padding: $base-line-height / 2 $base-line-height / 2 + font-family: $code-font-family + div[class^='highlight'] pre + white-space: pre + margin: 0 + padding: $base-line-height / 2 $base-line-height / 2 + font-family: $code-font-family + display: block + overflow: auto + pre.literal-block, div[class^='highlight'] pre, .linenodiv pre + font-size: 12px + line-height: normal + + @media print + .codeblock, div[class^='highlight'], div[class^='highlight'] pre + white-space: pre-wrap + // These are the various note pullouts that sphinx applies .note, .attention, .caution, .danger, .error, .hint, .important, .tip, .warning, .seealso, .admonition-todo, .admonition @extend .wy-alert diff --git a/sass/theme.sass b/sass/theme.sass index c7322b74..5ae5a075 100644 --- a/sass/theme.sass +++ b/sass/theme.sass @@ -40,10 +40,6 @@ @import wyrm_core/table @import wyrm_core/type -// Pygments styling -@import wyrm_addons/pygments/pygments -@import wyrm_addons/pygments/pygments_light - // Theme specific styles. These are likely the files you want to edit. @import theme_breadcrumbs @import theme_layout diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index e647bddd..21ddbaf5 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -86,7 +86,7 @@ - + {% block extrabody %} {% endblock %}
@@ -152,7 +152,7 @@
{# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #} -