Compare commits

..
Author SHA1 Message Date
Aaron Carlisle 1d790f623e Merge branch 'master' into blendify/v2 2021-03-20 03:03:12 -04:00
Aaron Carlisle 114fb85b44 Require Sphinx 1.6 deprecate html4 (#1091)
Sphinx 1.6 is required for de76c03824 we also do not test against versions lower than 1.6 so we should safely drop it.

This is similar to #1076 and #1075 but less strict
2021-03-15 18:05:20 -04:00
Aaron Carlisle 68d4b8aac7 Javascript: Add support for deep toc levels (#1089)
In ca015a5704 support was added for tox levels up to 10.
This only fixed the css side, this commit makes a similar fix for the js side.

Fixes #893
2021-03-15 13:51:06 -05:00
Aaron Carlisle 57cf83ad18 Add missing endblock 2021-03-15 14:14:26 -04:00
Aaron Carlisle bb79a97013 Merge branch 'master' into blendify/v2 2021-03-15 14:08:09 -04:00
Santos Gallegos f8e71bf312 Don't require npm to build from source (#1039) 2021-03-15 10:12:50 -05:00
Aaron Carlisle 85f23c9edc Docs: Add text before config api type information (#1090)
* Docs: Add text before config api type information

This makes it more clear what the confval is for without having to read through the type information.

This matches usual sphinx autodoc behavior.

* Only use one space above headings
2021-03-15 09:49:13 -05:00
Aaron Carlisle b33d06444e npm: Add a few missing package fields (#1079)
* npm: Add a few missing package fields

This fixes these warnings when running `npm install`:

```
npm WARN sphinx_rtd_theme@0.5.1 No repository field.
npm WARN sphinx_rtd_theme@0.5.1 No license field.
```

* 0.5.2

* Revert version bump

* Revert version bump
2021-03-12 18:12:31 -05:00
Aaron Carlisle ba1cbb1c07 Docs: Always use local theme (#1083)
This changes non PR builds on rtd to use the local theme and not the old 0.4.3 theme. We want our docs to show what the theme looks like based on the current release, not an old version.
2021-03-12 15:17:35 -05:00
Aaron Carlisle 0902912301 Fix API docs 2021-03-05 00:28:19 -05:00
Aaron Carlisle 76774437de Correct Sass Syntax
This causes issues with dart-sass compiler
2021-03-04 17:14:15 -05:00
Aaron Carlisle a30c614df3 Use dart sass instead of node-sass
Node sass is now deprecated, dart-sass is now the main implementation.
There is no change to the built assets.

For more information see
https://sass-lang.com/blog/libsass-is-deprecated
2021-03-04 16:48:31 -05:00
Aaron Carlisle 5734cf894e Remove Bourbon 2021-03-04 16:35:03 -05:00
Aaron Carlisle 1a79dc28cb Revert npm7 changes 2021-03-04 16:08:59 -05:00
Aaron Carlisle d2c4b2ecc2 Merge branch 'master' into blendify/v2 2021-03-04 16:03:33 -05:00
Aaron Carlisle 4c3ec57e52 Revert "Commit compiled assets for test"
This reverts commit c92d09ebc2.
2021-03-02 17:17:04 -05:00
Aaron Carlisle c92d09ebc2 Commit compiled assets for test 2021-03-02 17:14:37 -05:00
Aaron Carlisle 15c96303e0 Remove Semicolins 2021-03-02 16:44:42 -05:00
Aaron Carlisle d8567aebb3 Add back comment 2021-03-02 16:42:32 -05:00
Aaron Carlisle dc3b0c2db0 Remove Semicolins from sass 2021-03-02 16:41:08 -05:00
Aaron Carlisle 1b24af192d Cleanup: Theme Variables 2021-03-02 16:39:16 -05:00
Aaron Carlisle f0f116e420 Remove unused sidebar sass 2021-03-02 16:24:56 -05:00
Aaron Carlisle 28a72b1270 Fix syntax 2021-03-02 16:01:52 -05:00
Aaron Carlisle c490c3b6c2 Use Bootstrap clearfix 2021-03-02 15:46:50 -05:00
Aaron Carlisle 0205a77bb9 Optimize Badge Only Imports 2021-03-02 15:36:51 -05:00
Aaron Carlisle 30de695eef Cleanup neat import 2021-03-02 15:34:22 -05:00
Aaron Carlisle 229ff95f7e Remove HTML4 Styling 2021-03-02 15:24:24 -05:00
Aaron Carlisle 29fa23a287 Set font size for blockquotes 2021-03-02 15:16:07 -05:00
Aaron Carlisle 5abb62fad2 Fix GUI Labels 2021-03-02 15:11:38 -05:00
Aaron Carlisle c3ab8bb172 Fix sidebar breakpoints 2021-03-02 15:06:24 -05:00
Aaron Carlisle f3d5f3820e Match old nav background color 2021-03-02 14:52:58 -05:00
Aaron Carlisle 0bed94e3db Admonition use text color 2021-03-02 14:44:27 -05:00
Aaron Carlisle a7a7f4613a Fix literal-block padding 2021-03-02 14:39:01 -05:00
Aaron Carlisle 4c8b38032c Increase sidebar title contrast 2021-03-02 14:33:50 -05:00
Aaron Carlisle a33aa2453d Remove underline from heading hover 2021-03-02 14:31:40 -05:00
Aaron Carlisle da4c161eb9 Improve method parameter contrast 2021-03-02 14:28:41 -05:00
Aaron Carlisle 74b0260037 Fix API class background 2021-03-02 14:22:07 -05:00
Aaron Carlisle a46d3976f5 Fix one off pixel error 2021-03-02 14:03:41 -05:00
Aaron Carlisle 9d49402443 Add some padding to rst versions 2021-03-01 18:20:07 -05:00
Aaron Carlisle d9ed99cf70 Cleanup: Whitespace 2021-03-01 17:58:12 -05:00
Aaron Carlisle 7748a340f7 Fix sidebar scroll 2021-03-01 17:52:26 -05:00
Aaron Carlisle c96caa7c8b Update lockfile 2021-03-01 17:39:24 -05:00
Aaron Carlisle 9907652544 Merge branch 'master' into blendify/v2 2021-03-01 17:31:58 -05:00
Aaron Carlisle bc9cb59e38 Merge branch 'master' into blendify/v2 2021-03-01 09:50:09 -05:00
Aaron Carlisle b5323a480a Remove html5 shiv for ie 9 support 2021-02-28 23:42:26 -05:00
Aaron Carlisle 44b98be6d9 Revert Demo doc changes 2021-02-28 15:52:21 -05:00
Aaron Carlisle a5a9008690 Merge branch 'blendify/v2' of github.com:readthedocs/sphinx_rtd_theme into blendify/v2 2021-02-28 15:49:38 -05:00
Aaron Carlisle 881c9ceaca Fix breadcrumb classes 2021-02-28 15:47:19 -05:00
Aaron Carlisle 0b08d5f238 Fix breadcrumb classes 2021-02-28 15:46:23 -05:00
Aaron Carlisle f7536a708c Fix Breadcrumbs aside 2021-02-26 19:21:17 -05:00
Aaron Carlisle 1bc8580d82 Remove Preinstall for good 2021-02-26 19:04:31 -05:00
Aaron Carlisle 84bc56eb00 Update some old classes 2021-02-26 19:00:01 -05:00
Aaron Carlisle 8a9e4f7eb8 Add back literal border 2021-02-26 18:53:09 -05:00
Aaron Carlisle c8c28e1bd7 Fix font difference 2021-02-26 18:44:57 -05:00
Aaron Carlisle 9fe364293d Set font family for body and not html 2021-02-26 18:27:10 -05:00
Aaron Carlisle 51ab0be333 Basic kbd support 2021-02-26 18:12:26 -05:00
Aaron Carlisle be49272404 Port sidebar navigation 2021-02-26 17:47:16 -05:00
Aaron Carlisle 5e60c37c6c More layout fixes 2021-02-26 17:35:04 -05:00
Aaron Carlisle 6a927aad23 Update Main Content Layout 2021-02-26 17:18:21 -05:00
Aaron Carlisle b9075073f2 Initial Bootstrap layout 2021-02-23 16:19:24 -05:00
Aaron Carlisle be9262f022 Remove wy-menu 2021-02-23 15:28:57 -05:00
Aaron Carlisle b84f56bced Rename wy-nav-shift to sidebar collapse 2021-02-23 15:22:41 -05:00
Aaron Carlisle 2c63bc713c Remove wy-grid-for-nav 2021-02-23 14:55:26 -05:00
Aaron Carlisle 12bc1a0a02 remove wy-body-for-nav 2021-02-23 14:55:26 -05:00
Aaron Carlisle cb445ebd68 Merge branch 'master' into blendify/v2 2021-02-23 14:39:35 -05:00
Aaron Carlisle 4726038d51 Merge branch 'master' into blendify/v2 2021-02-23 12:52:36 -05:00
Aaron Carlisle e9c72c54d7 Fix syntax 2021-02-23 02:16:01 -05:00
Aaron Carlisle 2d7508f32e Use bootstrap var names 2021-02-23 02:14:27 -05:00
Aaron Carlisle 904527da28 Remove $custom-font-family 2021-02-23 02:10:00 -05:00
Aaron Carlisle 643e72f24e Update buttons 2021-02-23 01:56:15 -05:00
Aaron Carlisle b8d383dad6 Cleanup Sidebar colors 2021-02-23 01:47:39 -05:00
Aaron Carlisle 76facb84f6 Use darker gray for nav background 2021-02-23 01:42:00 -05:00
Aaron Carlisle c4733dc75e Lighten border colors 2021-02-23 01:41:27 -05:00
Aaron Carlisle 843999990a Merge list includes from wyrm 2021-02-23 01:35:50 -05:00
Aaron Carlisle c9957fb687 Fix list padding 2021-02-23 01:30:30 -05:00
Aaron Carlisle a0efa83a75 Use bootstap breakpoints 2021-02-23 00:52:59 -05:00
Aaron Carlisle 3242c93a24 Remove unused table vars 2021-02-23 00:42:40 -05:00
Aaron Carlisle 023cf01fef Remove unused custom font family 2021-02-23 00:34:57 -05:00
Aaron Carlisle 37c8833d4c Cleanup: Remove unused vars 2021-02-23 00:33:57 -05:00
Aaron Carlisle 791508810f Remove duplicate font stack 2021-02-23 00:20:29 -05:00
Aaron Carlisle 9fa20aeca8 Add alert heading
this does not yet work for some reason
2021-02-23 00:12:34 -05:00
Aaron Carlisle 402d196979 Initial breadcrumbs
the aside needs to be fixed
2021-02-23 00:03:49 -05:00
Aaron Carlisle d0a1a492f5 Update searchbox 2021-02-22 23:10:19 -05:00
Aaron Carlisle c700eb023a Remove unused code 2021-02-22 23:01:56 -05:00
Aaron Carlisle d1de49a420 Add blockquotes 2021-02-22 23:01:37 -05:00
Aaron Carlisle 400a828775 Responsive tables 2021-02-22 22:47:26 -05:00
Aaron Carlisle dad1a5d71e Add borded tables 2021-02-22 22:43:17 -05:00
Aaron Carlisle 1360f90f6a Migrate basic tables 2021-02-22 22:39:52 -05:00
Aaron Carlisle 59bfa060c0 Migrate .admonition 2021-02-22 22:35:12 -05:00
Aaron Carlisle 34a07bb908 Remove unused wy-breadcrumbs-extra 2021-02-22 22:22:00 -05:00
Aaron Carlisle 5148401c84 Remove more unused vars 2021-02-22 22:08:56 -05:00
Aaron Carlisle 866b49556a Change literal color to red var 2021-02-22 22:08:32 -05:00
Aaron Carlisle 1963f8f3cd Remove unused colors for backgrounds and buttons 2021-02-22 21:42:51 -05:00
Aaron Carlisle 509f465460 Remove wyrm colors 2021-02-22 21:38:09 -05:00
Aaron Carlisle 59eba1e7b6 Convert gray scale vars to bootstrap 2021-02-22 21:32:50 -05:00
Aaron Carlisle ed130f7bc0 Cleanup formatting 2021-02-22 21:16:10 -05:00
Aaron Carlisle 0dc2512a92 Add mising import 2021-02-22 21:15:38 -05:00
Aaron Carlisle 813feafd8c Remove Unused static-img var 2021-02-22 21:10:33 -05:00
Aaron Carlisle eedd6bf2f1 Remove Some unused vars 2021-02-22 21:08:06 -05:00
Aaron Carlisle 02f7b76957 Sass update to bootsrap zindex values 2021-02-22 21:04:15 -05:00
Aaron Carlisle fefd4521f0 remove unused wy-body-mask 2021-02-22 20:57:00 -05:00
Aaron Carlisle 6eb7506c32 Remove unused icon variables 2021-02-22 20:51:03 -05:00
Aaron Carlisle b0c1832da6 Inital Move to bootstrap 2021-02-22 20:43:58 -05:00
26 changed files with 521 additions and 1757 deletions

No files matched your search

+3 -1
View File
@@ -1,9 +1,11 @@
version: 2
python:
version: 3
version: 3.8
install:
- requirements: docs/requirements.txt
- method: pip
path: .
sphinx:
configuration: docs/conf.py
-1
View File
@@ -1,7 +1,6 @@
include *.txt
include babel.cfg
include LICENSE
include bin/preinstall.js
recursive-include sphinx_rtd_theme *.conf
recursive-include sphinx_rtd_theme *.css
recursive-include sphinx_rtd_theme *.eot
-20
View File
@@ -1,20 +0,0 @@
#!/usr/bin/env node
const package = require('../package.json');
// Sorry everyone, this is the closest we can get to commenting on package.json
// dependencies :(
if (package.devDependencies['bourbon-neat'] !== '~1.9') {
// Wyrm is not compatible with Neat 2.0+, and Neat 1.9 at least pins a
// node-sass version that doesn't require Python 2. The changes to Wyrm to
// support Neat 2.0+ are all fairly minor changes, but it deeply affects the
// grid system and might be more of a liability than an old release of Neat.
// See: https://github.com/readthedocs/sphinx_rtd_theme/pull/771
console.error(
'bourbon-neat 1.9 is required, Wyrm is not compatible with Neat 2.0+.'
);
console.error(
'The expected selector for the bourbon-neat dependency in package.json is "~1.9".'
);
process.exit(1);
}
+3 -37
View File
@@ -3,23 +3,10 @@
import sys
import os
import re
import time
# If we are building locally, or the build on Read the Docs looks like a PR
# build, prefer to use the version of the theme in this repo, not the installed
# version of the theme.
def is_development_build():
# PR builds have an interger version
re_version = re.compile(r'^[\d]+$')
if 'READTHEDOCS' in os.environ:
version = os.environ.get('READTHEDOCS_VERSION', '')
if re_version.match(version):
return True
return False
return True
if is_development_build():
sys.path.insert(0, os.path.abspath('..'))
# Prefer to use the version of the theme in this repo
# and not the installed version of the theme.
sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.abspath('./demo/'))
import sphinx_rtd_theme
@@ -119,24 +106,3 @@ def setup(app):
),
]
)
# Add cache busting just for our docs for now. This will make PR testing
# more accurate, as CDN caching of static assets makes it impossible to see
# style changes on additional commits.
re_cache_files = re.compile('^.*\.(js|css|svg|woff2?|png)$')
def event_context_no_cache(app, pagename, templatename, context, doctree):
pathto = context['pathto']
def pathto_no_cache(*args, **kwargs):
uri = pathto(*args, **kwargs)
if re_cache_files.match(uri):
postfix = str(int(time.time()))
if 'commit' in context:
postfix = context['commit']
uri = "{uri}?{postfix}".format(uri=uri, postfix=postfix)
return uri
context['pathto'] = pathto_no_cache
app.connect('html-page-context', event_context_no_cache)
+41 -41
View File
@@ -37,49 +37,49 @@ documentation navigation.
.. confval:: collapse_navigation
:type: boolean
:default: ``True``
With this enabled, navigation entries are not expandable -- the ``[+]``
icons next to each entry are removed.
:type: boolean
:default: ``True``
.. note::
Setting :confval:`collapse_navigation` to ``False`` and using a high value
for :confval:`navigation_depth` on projects with many files and a deep file
structure can cause long compilation times and can result in HTML files that
are significantly larger in file size.
.. confval:: sticky_navigation
Scroll the navigation with the main page content as you scroll the page.
:type: boolean
:default: ``True``
Scroll the navigation with the main page content as you scroll the page.
.. confval:: navigation_depth
:type: integer
:default: ``4``
The maximum depth of the table of contents tree. Set
this to ``-1`` to allow unlimited depth.
.. confval:: includehidden
:type: integer
:default: ``4``
:type: boolean
:default: ``True``
.. confval:: includehidden
Specifies if the navigation includes hidden table(s) of contents -- that is,
any :rst:dir:`sphinx:toctree` directive that is marked with the ``:hidden:``
option.
.. confval:: titles_only
:type: boolean
:default: False
:default: ``True``
.. confval:: titles_only
When enabled, page subheadings are not included in the
navigation.
.. note::
Setting :confval:`collapse_navigation` to ``False`` and using a high value
for :confval:`navigation_depth` on projects with many files and a deep file
structure can cause long compilation times and can result in HTML files that
are significantly larger in file size.
:type: boolean
:default: False
.. _table of contents configuration options: http://www.sphinx-doc.org/en/stable/templating.html#toctree
@@ -96,28 +96,28 @@ Miscellaneous options
.. confval:: analytics_id
:type: string
If specified, Google Analytics' javascript is included in your pages.
Set the value to the ID provided to you by google (like ``UA-XXXXXXX``).
:type: string
.. confval:: analytics_anonymize_ip
Anonymize visitor IP addresses in Google Analytics.
:type: boolean
:default: ``False``
Anonymize visitor IP addresses in Google Analytics.
.. confval:: canonical_url
:type: URL
This will specify a `canonical URL`_ meta link element to tell search
engines which URL should be ranked as the primary URL for your
documentation. This is important if you have multiple URLs that your
documentation is available through. The URL points to the root path of the
documentation and requires a trailing slash.
:type: URL
.. deprecated:: 0.6.0
Use :confval:`sphinx:html_baseurl` instead.
@@ -126,51 +126,52 @@ Miscellaneous options
.. confval:: display_version
If ``True``, the version number is shown at the top of the sidebar.
:type: boolean
:default: ``True``
If ``True``, the version number is shown at the top of the sidebar.
.. confval:: logo_only
:type: boolean
:default: ``False``
Only display the logo image, do not display the project name at the top of
the sidebar
.. confval:: prev_next_buttons_location
:type: boolean
:default: ``False``
:type: string
:default: ``bottom``
.. confval:: prev_next_buttons_location
Location to display :guilabel:`Next` and :guilabel:`Previous` buttons. This
can be either ``bottom``, ``top``, ``both`` , or ``None``.
:type: string
:default: ``bottom``
.. confval:: style_external_links
Add an icon next to external links.
:type: boolean
:default: ``False``
Add an icon next to external links.
.. confval:: vcs_pageview_mode
:type: string
:default: ``blob`` or ``view``
Changes how to view files when using ``display_github``, ``display_gitlab``,
etc. When using GitHub or GitLab this can be: ``blob`` (default), ``edit``,
or ``raw``. On Bitbucket, this can be either: ``view`` (default) or
``edit``.
:type: string
:default: ``blob`` or ``view``
.. confval:: style_nav_header_background
Changes the background of the search area in the navigation bar. The value
can be anything valid in a CSS `background` property.
:type: string
:default: ``#2980B9``
Changes the background of the search area in the navigation bar. The value
can be anything valid in a CSS `background` property.
File-wide metadata
==================
@@ -190,7 +191,6 @@ The following options can be used as :ref:`file-wide metadata
Force the :guilabel:`Edit on GitLab` button to use the configured URL.
Other configuration
===================
+5 -6
View File
@@ -59,7 +59,6 @@ can be used to test built assets:
.. _Webpack: https://webpack.js.org/
.. _node-sass: https://github.com/sass/node-sass
.. _SASS: http://www.sass-lang.com
.. _Wyrm: http://www.github.com/snide/wyrm/
.. _Sphinx: http://www.sphinx-doc.org/en/stable/
Translations
@@ -101,17 +100,17 @@ To release a new version of the theme, core team will take the following steps:
#. Update the changelog (``docs/changelog.rst``) with the version information.
#. Run ``python setup.py update_translations`` to compile new translation files
and update Transifex.
#. Run ``python setup.py build`` to rebuild all the theme assets and the Python
#. Run ``python setup.py build_assets`` to rebuild all the theme assets and the Python
package.
#. Commit these changes.
#. Tag the release in git: ``git tag $NEW_VERSION``.
#. Push the tag to GitHub: ``git push --tags origin``.
#. Upload the package to PyPI:
.. code:: console
.. code:: console
$ rm -rf dist/
$ python setup.py sdist bdist_wheel
$ twine upload --sign --identity security@readthedocs.org dist/*
$ rm -rf dist/
$ python setup.py sdist bdist_wheel
$ twine upload --sign --identity security@readthedocs.org dist/*
.. _PEP440: https://www.python.org/dev/peps/pep-0440/
+18 -4
View File
@@ -23,14 +23,20 @@ In your ``conf.py`` file:
.. note::
Adding this theme as an extension is what enables localization of theme
strings in your translated output. If these strings are not translated in
your output, either we lack the localized strings for your locale, or you
are using an old version of the theme.
Adding this theme as an extension is what enables localization of theme
strings in your translated output. If these strings are not translated in
your output, either we lack the localized strings for your locale, or you
are using an old version of the theme.
Via Git or Download
===================
.. warning::
Installing directly from the repo is deprecated.
Static assets won't be included in the repo in a future release.
Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into your documentation at
``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx
``conf.py`` file:
@@ -39,3 +45,11 @@ Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into you
html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]
Compatibility
=============
``sphinx_rtd_theme`` depends on at least Sphinx 1.6 although,
we recommend at least Sphinx 2 to take advantage of the html5 writer.
The html4 writer is still supported however,
it is deprecated and support will be removed in the near future.
+28 -1149
View File
File diff suppressed because it is too large. Load diff
+15 -8
View File
@@ -4,25 +4,33 @@
"version": "0.5.1",
"scripts": {
"dev": "webpack-dev-server --open --config webpack.dev.js",
"build": "webpack --config webpack.prod.js",
"preinstall": "bin/preinstall.js"
"build": "webpack --config webpack.prod.js"
},
"repository": {
"type": "git",
"url": "https://github.com/readthedocs/sphinx_rtd_theme.git"
},
"author": "Read the Docs",
"license": "MIT",
"bugs": {
"url": "https://github.com/readthedocs/sphinx_rtd_theme/issues"
},
"homepage": "https://github.com/readthedocs/sphinx_rtd_theme",
"dependencies": {},
"devDependencies": {
"bourbon": "~4.3",
"bourbon-neat": "~1.9",
"bootstrap": "^4.6.0",
"copy-webpack-plugin": "^5.1.1",
"css-loader": "^3.1.0",
"file-loader": "^3.0.1",
"font-awesome": "^4.7.0",
"html5shiv": "^3.7.3",
"imports-loader": "^0.8.0",
"jquery": "^3.4.1",
"lato-font": "^3.0.0",
"mini-css-extract-plugin": "^0.6.0",
"node-sass": "^4.13.1",
"optimize-css-assets-webpack-plugin": "^5.0.3",
"popper.js": "^1.16.1",
"roboto-fontface": "^0.10.0",
"sass": "^1.32.8",
"sass-loader": "^7.3.0",
"style-loader": "^0.23.1",
"webpack": "^4.30.0",
@@ -30,7 +38,6 @@
"webpack-dev-server": "^3.3.1",
"webpack-merge": "^4.2.1",
"webpack-shell-plugin": "^0.5.0",
"webpack-watch-files-plugin": "^1.0.3",
"wyrm": "^1.0.9"
"webpack-watch-files-plugin": "^1.0.3"
}
}
+22 -15
View File
@@ -1,27 +1,29 @@
# -*- coding: utf-8 -*-
"""`sphinx_rtd_theme` lives on `Github`_.
.. _github: https://github.com/readthedocs/sphinx_rtd_theme
"""
import distutils.cmd
import os
import subprocess
import distutils.cmd
import setuptools.command.build_py
from io import open
from setuptools import setup
class WebpackBuildCommand(setuptools.command.build_py.build_py):
class WebpackBuildCommand(distutils.cmd.Command):
"""Prefix Python build with Webpack asset build"""
description = "Generate static assets"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
if not 'CI' in os.environ and not 'TOX_ENV_NAME' in os.environ:
subprocess.run(['npm', 'install'], check=True)
subprocess.run(['node_modules/.bin/webpack', '--config', 'webpack.prod.js'], check=True)
setuptools.command.build_py.build_py.run(self)
class WebpackDevelopCommand(distutils.cmd.Command):
@@ -95,7 +97,7 @@ setup(
cmdclass={
'update_translations': UpdateTranslationsCommand,
'transifex': TransifexCommand,
'build_py': WebpackBuildCommand,
'build_assets': WebpackBuildCommand,
'watch': WebpackDevelopCommand,
},
zip_safe=False,
@@ -115,7 +117,7 @@ setup(
]
},
install_requires=[
'sphinx'
'sphinx>=1.6'
],
tests_require=[
'pytest',
@@ -137,12 +139,17 @@ setup(
'Intended Audience :: Developers',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Operating System :: OS Independent',
'Topic :: Documentation',
'Topic :: Software Development :: Documentation',
],
project_urls={
'Homepage': 'https://sphinx-rtd-theme.readthedocs.io/',
'Source Code': 'https://github.com/readthedocs/sphinx_rtd_theme',
'Issue Tracker': 'https://github.com/readthedocs/sphinx_rtd_theme/issues',
},
)
+11 -9
View File
@@ -8,12 +8,7 @@ from os import path
from sphinx import version_info
from sphinx.locale import _
try:
# Avaliable from Sphinx 1.6
from sphinx.util.logging import getLogger
except ImportError:
from logging import getLogger
from sphinx.util.logging import getLogger
__version__ = '0.5.1'
@@ -38,9 +33,16 @@ def config_initiated(app, config):
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
def setup(app):
if version_info >= (1, 6, 0):
# Register the theme that can be referenced without adding a theme path
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
app.require_sphinx('1.6')
if version_info <= (2, 0, 0):
if not app.config.html_experimental_html5_writer:
logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme")
else:
if app.config.html4_writer:
logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme")
# Register the theme that can be referenced without adding a theme path
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
if version_info >= (1, 8, 0):
# Add Sphinx message catalog for newer versions of Sphinx
+11 -10
View File
@@ -27,16 +27,17 @@
{%- set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %}
<div role="navigation" aria-label="{{ _('Breadcrumbs') }}">
<ul class="wy-breadcrumbs">
<ol class="breadcrumb">
{%- block breadcrumbs %}
<li><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a> &raquo;</li>
{%- for doc in parents %}
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
{%- endfor %}
<li>{{ title }}</li>
<li class="breadcrumb-item"><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a></li>
{%- for doc in parents %}
<li class="breadcrumb-item"><a href="{{ doc.link|e }}">{{ doc.title }}</a></li>
{%- endfor %}
<li class="breadcrumb-item active">{{ title }}</li>
{%- endblock %}
{%- block breadcrumbs_aside %}
<li class="wy-breadcrumbs-aside">
<li class="breadcrumb-aside">
{%- if hasdoc(pagename) and display_vcs_links %}
{%- if display_github %}
{%- if check_meta and 'github_url' in meta %}
@@ -67,15 +68,15 @@
{%- endif %}
</li>
{%- endblock %}
</ul>
</ol>
{%- if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="{{ _('Breadcrumbs') }}">
{%- if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
<a href="{{ prev.link|e }}" class="btn btn-light float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
{%- endif %}
{%- if next %}
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="{{ next.link|e }}" class="btn btn-light float-right" title="{{ next.title|striptags|e }}" accesskey="n">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
{%- endif %}
</div>
{%- endif %}
+2 -2
View File
@@ -2,10 +2,10 @@
{%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
<div class="rst-footer-buttons" role="navigation" aria-label="{{ _('Footer') }}">
{%- if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
<a href="{{ prev.link|e }}" class="btn btn-light float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
{%- endif %}
{%- if next %}
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="{{ next.link|e }}" class="btn btn-light float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
{%- endif %}
</div>
{%- endif %}
+49 -51
View File
@@ -6,11 +6,10 @@
{%- else %}
{%- set titlesuffix = "" %}
{%- endif %}
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
{%- set sphinx_writer = 'writer-html5' if html5_doctype else 'writer-html4' -%}
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) -%}
<!DOCTYPE html>
<html class="{{ sphinx_writer }}" lang="{{ lang_attr }}" >
<html lang="{{ lang_attr }}" >
<head>
<meta charset="utf-8" />
{{- metatags }}
@@ -51,9 +50,6 @@
{#- JAVASCRIPTS #}
{%- block scripts %}
<!--[if lt IE 9]>
<script src="{{ pathto('_static/js/html5shiv.min.js', 1) }}"></script>
<![endif]-->
{%- if not embedded %}
{# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
{%- if sphinx_version >= "1.8.0" -%}
@@ -111,22 +107,23 @@
{%- block extrahead %} {% endblock %}
</head>
<body class="wy-body-for-nav">
<body>
{%- block extrabody %} {% endblock %}
<div class="wy-grid-for-nav">
{#- SIDE NAV, TOGGLES ON MOBILE #}
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
{%- block sidebartitle %}
<div class="d-flex" id="wrapper">
<!-- Sidebar -->
<div class="sidebar-right" id="sidebar-wrapper">
<div class="sidebar-scroll">
<div class="sidebar-heading">
{%- block sidebartitle %}
{%- if logo and theme_logo_only %}
<a href="{{ pathto(master_doc) }}">
{%- else %}
<a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}
{%- endif %}
{%- if logo %}
{#- Not strictly valid HTML, but it's the only way to display/scale
it properly, without weird scripting or heaps of work
@@ -134,7 +131,7 @@
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="{{ _('Logo') }}"/>
{%- endif %}
</a>
{%- if theme_display_version %}
{%- set nav_version = version %}
{%- if READTHEDOCS and current_version %}
@@ -146,14 +143,14 @@
</div>
{%- endif %}
{%- endif %}
{%- include "searchbox.html" %}
{%- endblock %}
</div>
{%- block navigation %}
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Main') }}">
<div class="sidebar-navigation" data-spy="affix" role="navigation" aria-label="{{ _('Main') }}">
{%- block menu %}
{%- set toctree = toctree(maxdepth=theme_navigation_depth|int,
collapse=theme_collapse_navigation|tobool,
@@ -166,48 +163,49 @@
<div class="local-toc">{{ toc }}</div>
{%- endif %}
{%- endblock %}
</div>
{%- endblock %}
</div>
{%- endblock %}
</div>
</nav>
</div>
<!-- /#sidebar-wrapper -->
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
{#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
<nav class="wy-nav-top" aria-label="{{ _('Top') }}">
<!-- Page Content -->
<div class="page-content-wrapper">
<nav class="wy-nav-top navbar navbar-expand-lg navbar-light bg-light border-bottom" aria-label="{{ _('Top') }}">
{%- block mobile_nav %}
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
{%- endblock %}
</nav>
<div class="wy-nav-content">
{%- block content %}
{%- if theme_style_external_links|tobool %}
<div class="rst-content style-external-links">
{%- else %}
<div class="rst-content">
{%- endif %}
{% include "breadcrumbs.html" %}
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
{%- block document %}
<div itemprop="articleBody">
{% block body %}{% endblock %}
</div>
{%- if self.comments()|trim %}
<div class="articleComments">
<div class="container-fluid">
{%- block content %}
{%- if theme_style_external_links|tobool %}
<div class="rst-content style-external-links">
{%- else %}
<div class="rst-content">
{%- endif %}
{% include "breadcrumbs.html" %}
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
{%- block document %}
<div itemprop="articleBody">
{% block body %}{% endblock %}
</div>
{%- if self.comments()|trim %}
<div class="articleComments">
{%- block comments %}{% endblock %}
</div>
{%- endif%}
</div>
{%- endif%}
</div>
{%- endblock %}
{% include "footer.html" %}
</div>
{%- endblock %}
{%- endblock %}
{%- include "footer.html" %}
</div>
{%- endblock %}
</div>
</section>
</div>
<!-- /#page-content-wrapper -->
</div>
{% include "versions.html" -%}
{%- include "versions.html" -%}
<script type="text/javascript">
jQuery(function () {
+3 -3
View File
@@ -1,7 +1,7 @@
{%- if 'singlehtml' not in builder %}
<div role="search">
<form id="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get">
<input type="text" name="q" placeholder="{{ _('Search docs') }}" />
<div class="form-outline" role="search">
<form id="rtd-search-form" action="{{ pathto('search') }}" method="get">
<input type="search" name="q" class="form-control" placeholder="{{ _('Search docs') }}" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
+1 -1
View File
@@ -1,4 +1,4 @@
html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before,.wy-nav-top a,.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*!
* Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome
* License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
*/@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li span.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li span.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li span.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.downloadLine truncated
*/@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li span.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li span.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li span.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.downloadLine truncated
+11 -11
View File
@@ -4,23 +4,23 @@
left: 0
width: $nav-desktop-width
color: $section-background-color
background: darken($menu-background-color, 8%)
font-family: $base-font-family
z-index: $z-index-tray
background: darken($nav-background-color, 8%)
font-family: $font-family-base
z-index: $zindex-popover
a
color: $link_color
text-decoration: none
.rst-badge-small
display: none
.rst-current-version
padding: $base-line-height / 2
background-color: darken($menu-background-color, 5%)
padding: $line-height-base / 2
background-color: darken($nav-background-color, 5%)
display: block
text-align: right
font-size: 90%
cursor: pointer
color: $green
+clearfix
@include clearfix
.fa
color: $section-background-color
.fa-book
@@ -41,7 +41,7 @@
display: block
.rst-other-versions
font-size: 90%
padding: $base-line-height / 2
padding: $line-height-base / 2
color: $text-medium
display: none
hr
@@ -50,13 +50,13 @@
border: 0
margin: 20px 0
padding: 0
border-top: solid 1px lighten($menu-background-color, 5%)
border-top: solid 1px lighten($nav-background-color, 5%)
dd
display: inline-block
margin: 0
a
display: inline-block
padding: $base-line-height / 4
padding: $line-height-base / 4
color: $section-background-color
&.rst-badge
width: auto
@@ -82,11 +82,11 @@
width: auto
height: 30px
line-height: 30px
padding: 0 $base-line-height / 4
padding: 0 $line-height-base / 4
display: block
text-align: center
+media($tablet)
@media (max-width: $nav-media-query)
.rst-versions
width: 85%
display: none
-3
View File
@@ -1,7 +1,5 @@
// Slimmer version of FA for use on the badge_only.sass file.
+font-face(FontAwesome, '#{$fa-font-path}/fontawesome-webfont')
.fa:before
display: inline-block
font-family: FontAwesome
@@ -9,7 +7,6 @@
font-weight: normal
line-height: 1
text-decoration: inherit
+font-smooth
a .fa
display: inline-block
+8 -28
View File
@@ -1,34 +1,14 @@
.wy-breadcrumbs
+clearfix
.breadcrumb
padding-left: 0px
background-color: inherit
.wy-breadcrumbs li
display: inline-block
&.wy-breadcrumbs-aside
float: right
a
display: inline-block
padding: 5px
&:first-child
padding-left: 0
code
padding: 5px
border: none
background: none
&.literal
color: $text-color
.wy-breadcrumbs-extra
margin-bottom: 0
color: $text-light
font-size: 80%
display: inline-block
.breadcrumb-aside
margin-left: auto
+media($mobile)
.wy-breadcrumbs-extra
display: none
.wy-breadcrumbs li.wy-breadcrumbs-aside
@include media-breakpoint-down(sm)
.breadcrumb li.breadcrumb-aside
display: none
@media print
.wy-breadcrumbs li.wy-breadcrumbs-aside
.breadcrumb li.breadcrumb-aside
display: none
+82 -108
View File
@@ -1,41 +1,41 @@
// Set uniform (but not relative) base font size
html
font-size: $base-font-size
body
font-family: $font-family-base
font-size: $font-size-base
.wy-affix
position: fixed
top: $gutter
h1, h2, h3, h4, h5, h6
font-family: $font-family-headings
font-weight: 700
margin-bottom: $line-height-base
h1
font-size: 175%
h2
font-size: 150%
h3
font-size: 125%
h4
font-size: 115%
h5
font-size: 110%
h6
font-size: 100%
ol, ul
padding-left: 0px
.sidebar-navigation
width: $nav-desktop-width
.wy-menu
a:hover
text-decoration: none
.wy-menu-horiz
+clearfix
ul, li
display: inline-block
li:hover
background: rgba(255,255,255,.1)
li
&.divide-left
border-left: solid 1px hsl(0, 0%, 25%)
&.divide-right
border-right: solid 1px hsl(0, 0%, 25%)
a
height: $base-font-size * 2
display: inline-block
line-height: $base-font-size * 2
padding: 0 $base-font-size
.wy-menu-vertical
width: $nav-desktop-width
header, p.caption
color: $nav-caption
height: $base-font-size * 2
line-height: $base-font-size * 2
height: $font-size-base * 2
line-height: $font-size-base * 2
padding: 0 $gutter
margin: $base-line-height / 2 0 0 0
margin: $line-height-base / 2 0 0 0
display: block
font-weight: bold
text-transform: uppercase
@@ -50,13 +50,13 @@ html
&.divide-bottom
border-bottom: solid 1px hsl(0, 0%, 25%)
&.current
background: darken($menu-vertical-background-color, 10%)
background: darken($nav-menu-background-color, 10%)
a
color: $menu-link-medium
border-right: solid 1px darken($menu-vertical-background-color, 20%)
border-right: solid 1px darken($nav-menu-background-color, 20%)
padding: $gutter / 4 $gutter * 1.5
&:hover
background: darken($menu-vertical-background-color, 15%)
background: darken($nav-menu-background-color, 15%)
code
border: none
background: inherit
@@ -79,12 +79,11 @@ html
padding: $gutter / 4 $gutter
font-weight: bold
position: relative
background: $menu-vertical-background-color
background: $nav-menu-background-color
border: none
padding-left: $gutter -4px
+font-smooth
&:hover
background: $menu-vertical-background-color
background: $nav-menu-background-color
span.toctree-expand
color: $menu-link-medium
span.toctree-expand
@@ -95,8 +94,8 @@ html
color: darken($menu-link-medium, 30%)
li.toctree-l1.current > a
border-bottom: solid 1px darken($menu-vertical-background-color, 20%)
border-top: solid 1px darken($menu-vertical-background-color, 20%)
border-bottom: solid 1px darken($nav-menu-background-color, 20%)
border-top: solid 1px darken($nav-menu-background-color, 20%)
// This is the on state for pages beyond second level
@@ -143,19 +142,19 @@ html
li.toctree-l2
&.current
> a
background: darken($menu-vertical-background-color, 20%)
background: darken($nav-menu-background-color, 20%)
li.toctree-l3 > a
background: darken($menu-vertical-background-color, 20%)
background: darken($nav-menu-background-color, 20%)
span.toctree-expand
color: darken($menu-vertical-background-color, 35%)
color: darken($nav-menu-background-color, 35%)
li.toctree-l3
&.current
> a
background: darken($menu-vertical-background-color, 25%)
background: darken($nav-menu-background-color, 25%)
li.toctree-l4 > a
background: darken($menu-vertical-background-color, 25%)
background: darken($nav-menu-background-color, 25%)
span.toctree-expand
color: darken($menu-vertical-background-color, 40%)
color: darken($nav-menu-background-color, 40%)
li.current ul
display: block
@@ -174,23 +173,23 @@ html
font-size: 90%
color: $menu-link-light
&:hover
background-color: lighten($menu-background-color, 10%)
background-color: lighten($nav-background-color, 10%)
cursor: pointer
span.toctree-expand
color: $menu-link-light
&:active
background-color: $menu-logo-color
background-color: $nav-search-background-color
cursor: pointer
color: $menu-link-active
span.toctree-expand
color: $menu-link-active
.wy-side-nav-search
.sidebar-heading
display: block
width: $nav-desktop-width
padding: $gutter / 2
margin-bottom: $gutter / 2
z-index: $z-index-popover
z-index: $zindex-fixed
background-color: $nav-search-background-color
text-align: center
color: $nav-search-color
@@ -204,17 +203,16 @@ html
margin: auto auto $gutter / 2 auto
height: 45px
width: 45px
background-color: $menu-logo-color
background-color: $nav-search-background-color
padding: 5px
border-radius: 100%
> a, .wy-dropdown > a
> a
color: $nav-search-color
font-size: 100%
font-weight: bold
display: inline-block
padding: $base-line-height / 6 $base-line-height / 4
padding: $line-height-base / 6 $line-height-base / 4
margin-bottom: $gutter / 2
+font-smooth
&:hover
background: rgba(255,255,255,.1)
img.logo
@@ -234,15 +232,6 @@ html
font-weight: normal
color: rgba(255,255,255,.3)
.wy-nav .wy-menu-vertical
header
color: $link-color
a
color: $text-light
&:hover
background-color: $link-color
color: $white
[data-menu-wrap]
+transition(all .2s ease-in)
position: absolute
@@ -262,15 +251,10 @@ html
left: auto
opacity: 0
.wy-body-for-nav
.d-flex
background: $section-background-color
.wy-grid-for-nav
position: absolute
width: 100%
height: 100%
.wy-nav-side
.sidebar-right
position: fixed
top: 0
bottom: 0
@@ -280,11 +264,11 @@ html
overflow-x: hidden
overflow-y: hidden
min-height: 100%
color: $menu-medium
background: $nav-background-color
z-index: $z-index-popover
z-index: $zindex-fixed
.wy-side-scroll
.sidebar-scroll
padding-bottom: $gutter / 2
width: $nav-desktop-width + 20px
position: relative
overflow-x: hidden
@@ -300,16 +284,15 @@ html
line-height: 50px
text-align: center
font-size: 100%
+clearfix
@include clearfix
a
color: $white
font-weight: bold
+font-smooth
img
margin-right: $base-line-height / 2
margin-right: $line-height-base / 2
height: 45px
width: 45px
background-color: $menu-logo-color
background-color: $nav-search-background-color
padding: 5px
border-radius: 100%
i
@@ -318,72 +301,63 @@ html
cursor: pointer
padding-top: inherit
.wy-nav-content-wrap
.page-content-wrapper
margin-left: $nav-desktop-width
background: $section-background-color
background: $content-background-color
min-height: 100%
.wy-nav-content
.container-fluid
padding: $gutter $gutter * 2
height: 100%
max-width: $nav-content-width
margin: auto
.wy-body-mask
position: fixed
width: 100%
height: 100%
background: rgba(0,0,0,.2)
display: none
z-index: $z-index-modal - 1
&.on
display: block
footer
color: $footer-color
p
margin-bottom: $base-line-height / 2
margin-bottom: $line-height-base / 2
span.commit code
padding: 0px
font-family: $code-font-family
font-family: $font-family-code
font-size: 1em
background: none
border: none
color: $footer-color
.rst-footer-buttons
@include clearfix
&:before, &:after
width: 100%
+clearfix
.rst-breadcrumbs-buttons
@include clearfix
margin-top: 12px
+clearfix
#search-results
.search li
margin-bottom: $base-line-height
margin-bottom: $line-height-base
border-bottom: solid 1px $table_border_color
padding-bottom: $base-line-height
padding-bottom: $line-height-base
.search li:first-child
border-top: solid 1px $table_border_color
padding-top: $base-line-height
padding-top: $line-height-base
.search li a
font-size: 120%
margin-bottom: $base-line-height / 2
margin-bottom: $line-height-base / 2
display: inline-block
.context
color: $text-medium
font-size: 90%
.genindextable li > ul
margin-left: $base-line-height
margin-left: $line-height-base
+media($tablet)
.wy-body-for-nav
@media (max-width: $nav-media-query)
.d-flex
background: $section-background-color
.wy-nav-top
display: block
.wy-nav-side
.sidebar-right
@if $nav-desktop-position == left
left: -$nav-desktop-width
@else
@@ -391,15 +365,15 @@ footer
&.shift
width: 85%
left: 0
.wy-side-scroll
.sidebar-scroll
width: auto
.wy-side-nav-search
.sidebar-heading
width: auto
.wy-menu.wy-menu-vertical
.sidebar-navigation
width: auto
.wy-nav-content-wrap
.page-content-wrapper
margin-left: 0
.wy-nav-content
.container-fluid
padding: $gutter
&.shift
position: fixed
@@ -410,14 +384,14 @@ footer
overflow: hidden
@media screen and (min-width: $nav-media-query)
.wy-nav-content-wrap
.page-content-wrapper
background: rgba(0,0,0,.05)
.wy-nav-content
.container-fluid
margin: 0
background: $section-background-color
background: $content-background-color
@media print
.rst-versions, footer, .wy-nav-side
.rst-versions, footer, .sidebar-right
display: none
.wy-nav-content-wrap
.page-content-wrapper
margin-left: 0
+150 -152
View File
@@ -7,9 +7,8 @@
// * That said, know that I'm very unlikely to accept PRs from wyrm just to change style here.
// 2. I plan to remove the !importants in here. Part of it is due to lazyness, part to sphinx's fondness for nesting.
// 3. Try to use variables from wyrm_core/wy_variables.sass. Notable are...
// * $base-line-height // All margins, padding and line-height should use this in .25 increments.
// * $line-height-base // All margins, padding and line-height should use this in .25 increments.
// * $text-color, $text-light, $text-dark...etc
// * $base-font-family, $custom-font-family, $code-font-family
// 4. If you have changes for mobile/tablet, put them at the bottom of the sass file.
// --------------------------------------------------------------------------------------------------------------------
@@ -20,7 +19,7 @@
height: auto
div.figure
margin-bottom: $base-line-height
margin-bottom: $line-height-base
p.caption
font-style: italic
p:last-child.caption
@@ -31,7 +30,7 @@
// Usually it's a good idea to give images some space.
.section > img, .section > a > img
margin-bottom: $base-line-height
margin-bottom: $line-height-base
// normalize browser styling
abbr[title]
@@ -49,22 +48,24 @@
// For the most part, its safe to assume that sphinx wants you to use a blockquote as an indent. It gets
// used in many different ways, so don't assume you can apply some fancy style, just leave it be.
blockquote
margin-left: $base-line-height
line-height: $base-line-height
margin-bottom: $base-line-height
@extend .blockquote
margin-left: $line-height-base
line-height: $line-height-base
margin-bottom: $line-height-base
font-size: $font-size-base
pre.literal-block
white-space: pre
margin: 0
padding: $base-line-height / 2 $base-line-height / 2
font-family: $code-font-family
padding: $line-height-base / 2 $line-height-base / 2
font-family: $font-family-code
display: block
overflow: auto
pre.literal-block, div[class^='highlight']
border: 1px solid $table-border-color
border: 1px solid $gray-300
overflow-x: auto
// 1px hack otherwise border won't show. lame
margin: 1px 0 $base-line-height 0
margin: 1px 0 $line-height-base 0
div[class^='highlight']
padding: 0px
border: none
@@ -73,30 +74,33 @@
div[class^='highlight'] td.code
width: 100%
.linenodiv pre
border-right: solid 1px lighten($table-border-color, 2%)
border-right: solid 1px $gray-300
margin: 0
padding: $base-line-height / 2 $base-line-height / 2
font-family: $code-font-family
padding: $line-height-base / 2 $line-height-base / 2
font-family: $font-family-code
user-select: none
pointer-events: none
div[class^='highlight'] pre
white-space: pre
margin: 0
padding: $base-line-height / 2 $base-line-height / 2
padding: $line-height-base / 2 $line-height-base / 2
display: block
overflow: auto
& .hll
// Line emphasis spans full width
display: block
margin: 0 -1 * $base-line-height / 2
padding: 0 $base-line-height / 2
margin: 0 -1 * $line-height-base / 2
padding: 0 $line-height-base / 2
pre.literal-block, div[class^='highlight'] pre, .linenodiv pre
font-family: $code-font-family
font-family: $font-family-code
font-size: 12px
line-height: 1.4
.literal-block-wrapper
padding: 0px
// Do not allow selection of code block prompts
div.highlight .gp
div.highlight .gp
user-select: none
pointer-events: none
@@ -113,26 +117,27 @@
// 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
@extend .alert
color: $text-color
// These block elements are unsuitable for having floating objects next
// to them
clear: both
.last, > *:last-child
margin-bottom: 0
.admonition-title
@extend .wy-alert-title
// @extend .alert-heading
@extend .fa
@extend .fa-exclamation-circle
&:before
margin-right: 4px
.note, .seealso
@extend .wy-alert.wy-alert-info
@extend .alert-info
.hint, .tip, .important
@extend .wy-alert.wy-alert-success
@extend .alert-success
.error, .danger
@extend .wy-alert.wy-alert-danger
@extend .alert-danger
.warning, .caution, .attention, .admonition-todo
@extend .wy-alert.wy-alert-warning
@extend .alert-warning
// Some people put tables in notes. Let's give them very basic support.
.admonition table
border-color: rgba(0,0,0,.1)
@@ -140,27 +145,53 @@
background: transparent !important
border-color: rgba(0,0,0,.1) !important
.section ul, .toctree-wrapper ul
@extend .wy-plain-list-disc
list-style: disc
line-height: $line-height-base
margin-bottom: $line-height-base
li
list-style: disc
margin-left: $line-height-base
p:last-child
margin-bottom: 0
ul
margin-bottom: 0
li
list-style: circle
li
list-style: square
ol li
list-style: decimal
.section ol.loweralpha, .section ol.loweralpha > li
list-style: lower-alpha
.section ol.upperalpha, .section ol.upperalpha > li
list-style: upper-alpha
.section ol, ol.arabic
@extend .wy-plain-list-decimal
list-style: decimal
line-height: $line-height-base
margin-bottom: $line-height-base
li
list-style: decimal
margin-left: $line-height-base
p:last-child
margin-bottom: 0
ul
margin-bottom: 0
li
list-style: disc
// Complex bullet lists, they have more item margins than simple lists
.section ol li, .section ul li
> *
margin-top: $base-line-height / 2
margin-bottom: $base-line-height / 2
margin-top: $line-height-base / 2
margin-bottom: $line-height-base / 2
&:first-child
margin-top: 0rem
> p
&, &:last-child
margin-bottom: $base-line-height / 2
margin-bottom: $line-height-base / 2
&:only-child, &:only-child:last-child
margin-bottom: 0rem
> ul, > ol
margin-bottom: $base-line-height / 2
margin-bottom: $line-height-base / 2
// Simple lists, no item margins
.section ol.simple li, .section ul.simple li
> *
@@ -171,24 +202,26 @@
margin-bottom: 0rem
.line-block
margin-left: 0px
margin-bottom: $base-line-height
line-height: $base-line-height
margin-bottom: $line-height-base
line-height: $line-height-base
.line-block .line-block
margin-left: $base-line-height
margin-left: $line-height-base
margin-bottom: 0px
// Generics handling of headings and toc stuff.
.topic-title
font-weight: bold
margin-bottom: $base-line-height / 2
margin-bottom: $line-height-base / 2
.toc-backref
color: $text-color
&:hover
text-decoration-line: none
.align-right
float: right
margin: 0px 0px $base-line-height $base-line-height
margin: 0px 0px $line-height-base $line-height-base
.align-left
float: left
margin: 0px $base-line-height $base-line-height 0px
margin: 0px $line-height-base $line-height-base 0px
.align-center
margin: auto
// Do not override display:table for tables
@@ -215,33 +248,10 @@
.centered
text-align: center
// Sidebar content. You'll see at the bottom of this file I change it in mobile.
.sidebar
float: right
width: 40%
display: block
margin: 0 0 $base-line-height $base-line-height
padding: $base-line-height
background: $sidebar-background-color
border: solid 1px $sidebar-border-color
// Sidebar content is usually less relevant, so adjust the margins and sizes.
p, ul, dl
font-size: 90%
.last, > *:last-child
margin-bottom: 0
.sidebar-title
display: block
font-family: $custom-font-family
font-weight: bold
background: $table-border-color
padding: $base-line-height / 4 $base-line-height / 2
margin: -$base-line-height
margin-bottom: $base-line-height
font-size: 100%
// Sphinx can highlight searched text with ?highlighted=searchterm
.highlighted
background: $highlight-color
box-shadow: 0 0 0 $base-line-height / 12 $highlight-color
box-shadow: 0 0 0 $line-height-base / 12 $highlight-color
display: inline
font-weight: bold
@@ -257,98 +267,81 @@
.hlist
width: 100%
// The html4 writer outputs the citation and footnotes as a table, and the
// html5 writer outputs these as a definition list. We will use the fairly
// well supported css `grid` attribute to make these back into a table
// HTML4 writer
html.writer-html4 &
table.docutils.citation, table.docutils.footnote
background: none
border: none
td, tr
border: none
background-color: transparent !important
white-space: normal
td.label
padding-left: 0
padding-right: 0
vertical-align: top
// HTML5 writer
html.writer-html5 &
dl dt span.classifier
&:before
content: " : "
dl.footnote,
dl.field-list
display: grid
grid-template-columns: max-content auto
> dt
padding-left: 1rem
// Formate citation and footnotes as a table.
// We will use the fairly well supported css `grid` attribute
dl dt span.classifier
&:before
content: " : "
dl.footnote,
dl.field-list
display: grid
grid-template-columns: max-content auto
> dt
padding-left: 1rem
&:after
content: ":"
> dt, > dd
margin-bottom: 0rem
dl.footnote
font-size: .9rem
> dt
margin: 0rem .5rem .5rem 0rem
line-height: 1.2rem
word-break: break-all
font-weight: normal
> span.brackets
margin-right: .5rem
&:before
content: "["
&:after
content: ":"
> dt, > dd
margin-bottom: 0rem
dl.footnote
font-size: .9rem
> dt
margin: 0rem .5rem .5rem 0rem
line-height: 1.2rem
word-break: break-all
font-weight: normal
> span.brackets
margin-right: .5rem
&:before
content: "["
&:after
content: "]"
> span.fn-backref
font-style: italic
> dd
margin: 0rem 0rem .5rem 0rem
line-height: 1.2rem
p
font-size: .9rem
dl.option-list
kbd
content: "]"
> span.fn-backref
font-style: italic
> dd
margin: 0rem 0rem .5rem 0rem
line-height: 1.2rem
p
font-size: .9rem
// Both
html.writer-html4 & table.docutils.citation, table.docutils.footnote,
html.writer-html5 & dl.footnote
dl.option-list
kbd
font-size: .9rem
table.docutils.footnote, dl.footnote
color: $text-medium
code
color: $gray
color: $gray-500
// Remove the large vertical space between citations and footnotes
.wy-table-responsive.citation, .wy-table-responsive.footnote
.table-responsive.citation, .table-responsive.footnote
margin-bottom: 0
// Re-add vertical space to element directly following citation and footnotes,
// if the following element is of a different type
.wy-table-responsive.citation + :not(.citation),
.wy-table-responsive.footnote + :not(.footnote)
margin-top: $base-line-height
.table-responsive.citation + :not(.citation),
.table-responsive.footnote + :not(.footnote)
margin-top: $line-height-base
// Re-add vertical space after citation and footnotes if it is the last child of a parent
.wy-table-responsive.citation:last-child, .wy-table-responsive.footnote:last-child
margin-bottom: $base-line-height
.table-responsive.citation:last-child, .table-responsivefootnote:last-child
margin-bottom: $line-height-base
table.docutils
@extend .wy-table
@extend .wy-table-bordered-all
@extend .table
@extend .table-bordered
th
border-color: $table-border-color
border-color: $gray-300
html.writer-html5 &
border: 1px solid $table-border-color
border: 1px solid $gray-300
html.writer-html5 &
th > p, td > p
line-height: 1rem
margin-bottom: 0rem
font-size: .9rem
&:not(.field-list)
@extend .wy-table-striped
@extend .table-striped
// Remove bottom margin for the last element (and it's last child)
td .last, td .last > *:last-child
margin-bottom: 0
// This table is what gets spit out for auto-generated API stuff. I style it smaller bits of padding.
table.field-list
@extend .wy-table
@extend .table
border: none
td
border: none
@@ -368,57 +361,57 @@
tt, code
@extend code
color: $black
font-family: $code-font-family
font-family: $font-family-code
padding: 2px 5px
big, em
font-size: 100% !important
line-height: normal
&.literal
color: $text-code-color
border: 1px solid $gray-300
color: $red
white-space: normal
&.xref, a &
font-weight: bold
color: $text-codexref-color
pre, kbd, samp
font-family: $code-font-family
font-family: $font-family-code
// If the literal is inside an a tag, let's color it like a link
a tt, a code
color: $link-color
dl
margin-bottom: $base-line-height
margin-bottom: $line-height-base
dt
font-weight: bold
margin-bottom: $base-line-height / 2
margin-bottom: $line-height-base / 2
// Most of the content within these dls are one liners, so I halve the normal margins.
p, table, ul, ol
margin-bottom: $base-line-height / 2
margin-bottom: $line-height-base / 2
// rST seems to want dds to be treated as the browser would, indented.
dd
margin: 0 0 $base-line-height / 2 $base-line-height
line-height: $base-line-height
html.writer-html4 & dl:not(.docutils),
html.writer-html5 & dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)
margin-bottom: $base-line-height
margin: 0 0 $line-height-base / 2 $line-height-base
line-height: $line-height-base
dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)
margin-bottom: $line-height-base
> dt
display: table
margin: $base-line-height / 4 0
margin: $line-height-base / 4 0
font-size: 90%
line-height: normal
background: lighten($class-color, 50%)
background: lighten($class-color, 45%)
color: $class-color
border-top: solid 3px lighten($class-color, 20%)
padding: $base-line-height / 4
padding: $line-height-base / 4
position: relative
&:before
color: lighten($class-color, 20%)
.headerlink
color: $text-color
font-size: 100% !important
// In the html4 writer, parameters is a table. In html5 writer, parameters
// is a nested dl.field-list
// parameters
dl:not(.field-list) > dt
margin-bottom: $base-line-height / 4
margin-bottom: $line-height-base / 4
border: none
border-left: solid 3px hsl(0,0%,80%)
background: hsl(0,0%,94%)
@@ -426,6 +419,8 @@
.headerlink
color: $headerlink-color
font-size: 100% !important
&:not(.sig-name)
color: darken($method-color, 35%)
> dt:first-child
margin-top: 0
// Since dts get the callout style, we treat this less as callouts.
@@ -452,7 +447,7 @@
display: inline-block
color: $text-viewcode-color
font-size: 80%
padding-left: $base-line-height
padding-left: $line-height-base
.viewcode-back
display: block
float: right
@@ -477,18 +472,21 @@
margin-right: 4px
.guilabel
border: 1px solid lighten($guilabel-color, 25%)
background: lighten($guilabel-color, 50%)
background: lighten($guilabel-color, 45%)
font-size: 80%
font-weight: 700
border-radius: $base-line-height / 6
padding: $base-line-height / 10 $base-line-height / 4
margin: auto $base-line-height / 12
border-radius: $line-height-base / 6
padding: $line-height-base / 10 $line-height-base / 4
margin: auto $line-height-base / 12
kbd, .kbd
color: inherit
background: $gray-300
.versionmodified
font-style: italic
// Mobile specific
+media($mobile)
@include media-breakpoint-down(sm)
.rst-content
.sidebar
width: 100%
+37 -39
View File
@@ -1,69 +1,67 @@
// In here are varibles used for sphinx_rtd_theme, they either add to or overwrite the default ones
// that are set in wyrm_core/wy_variables.sass. You'll find wyrm in bower_components if you're looking
// for a reference.
// -------------------------Paths-------------------------
$fa-font-path: "~font-awesome/fonts"
$static-img: "../img/"
// -------------------------Layout-------------------------
$gutter: 1.618em // the golden ratio
$nav-desktop-position: left
$nav-desktop-width: 300px
$nav-content-width: 800px
$nav-media-query: (($nav-desktop-width) + ($nav-content-width))
$mathjax-color: $text-color
// -------------------------Typography-------------------------
$font-family-base: "Lato", "proxima-nova", "Helvetica Neue", Arial, sans-serif
$font-family-headings: "Roboto Slab", ff-tisa-web-pro, Georgia, Arial, sans-serif
$font-family-code: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", Courier, monospace
$font-display: block
$font-size-base: 16px
$line-height-base: 24px
// -------------------------Colors-------------------------
// Text
$text-color: hsl(0,0%,25%) !default
$text-dark: lighten($text-color,15%) !default
$text-medium: lighten($text-color,25%) !default
$text-light: lighten($text-color,45%) !default
$text-lighter: lighten($text-color,60%) !default
// Content
$section-background-color: $gray-200
$content-background-color: $white
$footer-color: $text-medium
// Links
$link-color: $blue
$link-color-visited: $purple
$headerlink-color: $text-color
// Math
$mathjax-color: $text-color
// Code colors
$text-viewcode-color: $green
$text-codexref-color: $text-color
// Definition list colors
$class-color: $blue
$method-color: $gray
$method-color: $gray-500
// GUI label color
$guilabel-color: $blue
// Footer colors
$footer-color: $text-medium
// Menu colors
$menu-vertical-background-color: $section-background-color
// Menu text colors
$menu-color: $gray
$menu-dark: lighten($menu-color,10%) !default
$menu-medium: lighten($menu-color,27.5%) !default
$menu-light: lighten($menu-color,45%) !default
$menu-lighter: lighten($menu-color,60%) !default
// Menu link colors
$menu-link-color: $text-color
$menu-link-dark: $text-dark
$menu-link-medium: $text-medium
$menu-link-light: $text-lighter
$menu-link-active: $white
// Navigation colors
$nav-background-color: $menu-background-color
$nav-search-background-color: $blue
$nav-background-color: #343131
$nav-search-background-color: #2980B9
$nav-search-color: $section-background-color
$nav-link-color: $blue
$nav-link-color-visited: $purple
$nav-link-color-hover: lighten($nav-link-color, 6%) !default
$nav-link-color-alt: hsl(33, 100%, 51%)
$nav-caption: lighten($blue, 15%)
// Sidebar colors
$sidebar-background-color: $table-stripe-color
$sidebar-border-color: $table-border-color
$sidebar-title-background-color: $table-border-color
$nav-menu-background-color: $section-background-color
$nav-caption: $nav-search-background-color
// Sphinx highlight color
$highlight-color: $yellow
$base-font-family: "Lato", "proxima-nova", "Helvetica Neue", Arial, sans-serif
$custom-font-family: "Roboto Slab", "ff-tisa-web-pro", "Georgia", Arial, sans-serif
$custom-font-family2: Georgia, serif
$code-font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", Courier, monospace
$font-display: block
+5 -8
View File
@@ -4,13 +4,10 @@
// This generates the RTD sticky badge for non RTD themes. As
// always, only files labeled "theme_*.sass should be edited".
// ------------------------------------------------------------
$border-box-sizing: false !default
@import wyrm_core/wy_variables
@import "node_modules/bootstrap/scss/functions"
@import "node_modules/bootstrap/scss/variables"
@import "node_modules/bootstrap/scss/mixins"
@import theme_variables
@import ~bourbon/app/assets/stylesheets/bourbon
@import ~bourbon-neat/app/assets/stylesheets/neat
@import wyrm_core/mixin
@import wyrm_core/grid_settings
@import _theme_badge_fa
@import _theme_badge
@import theme_badge_fa
@import theme_badge
+2 -27
View File
@@ -6,39 +6,14 @@
// "theme_*.sass". All other files are loaded through bower.
// ------------------------------------------------------------
// Variable defaults set by Wyrm
@import wyrm_core/wy_variables
@import ~bootstrap/scss/bootstrap
// Variable overrides that change coloring and fonts for this theme.
@import theme_variables
// bourbon.io framework
@import ~bourbon/app/assets/stylesheets/bourbon
// Bourbon.io/neat framework, with some default media queries
@import wyrm_core/grid_settings
@import ~bourbon-neat/app/assets/stylesheets/neat
// Some corrections for neat
@import wyrm_core/neat_extra
// Custom reset
@import wyrm_core/reset
// Wyrm mixins
@import wyrm_core/mixin
// Font Awesome with wyrm extras
// Font Awesome
@import ~font-awesome/scss/font-awesome
@import wyrm_core/font_icon_defaults
// Wyrm core styles used in this theme
@import wyrm_core/alert
@import wyrm_core/button
@import wyrm_core/dropdown
@import wyrm_core/form
@import wyrm_core/generic
@import wyrm_core/table
@import wyrm_core/type
// Theme specific styles. These are likely the files you want to edit.
@import theme_breadcrumbs
+12 -15
View File
@@ -80,15 +80,15 @@ function ThemeNav () {
$(document)
// Shift nav in mobile when clicking the menu.
.on('click', "[data-toggle='wy-nav-top']", function() {
$("[data-toggle='wy-nav-shift']").toggleClass("shift");
$("[data-toggle='sidebar-collapse']").toggleClass("shift");
$("[data-toggle='rst-versions']").toggleClass("shift");
})
// Nav menu link click operations
.on('click', ".wy-menu-vertical .current ul li a", function() {
.on('click', ".sidebar-navigation .current ul li a", function() {
var target = $(this);
// Close menu when you click a link.
$("[data-toggle='wy-nav-shift']").removeClass("shift");
$("[data-toggle='sidebar-collapse']").removeClass("shift");
$("[data-toggle='rst-versions']").toggleClass("shift");
// Handle dynamic display of l3 and l4 nav lists
self.toggleCurrent(target);
@@ -100,17 +100,17 @@ function ThemeNav () {
// Make tables responsive
$("table.docutils:not(.field-list,.footnote,.citation)")
.wrap("<div class='wy-table-responsive'></div>");
.wrap("<div class='table-responsive'></div>");
// Add extra class to responsive tables that contain
// footnotes or citations so that we can target them for styling
$("table.docutils.footnote")
.wrap("<div class='wy-table-responsive footnote'></div>");
.wrap("<div class='table-responsive footnote'></div>");
$("table.docutils.citation")
.wrap("<div class='wy-table-responsive citation'></div>");
.wrap("<div class='table-responsive citation'></div>");
// Add expand links to all parents of nested ul
$('.wy-menu-vertical ul').not('.simple').siblings('a').each(function () {
$('.sidebar-navigation ul').not('.simple').siblings('a').each(function () {
var link = $(this);
expand = $('<span class="toctree-expand"></span>');
expand.on('click', function (ev) {
@@ -127,7 +127,7 @@ function ThemeNav () {
var anchor = encodeURI(window.location.hash) || '#';
try {
var vmenu = $('.wy-menu-vertical');
var vmenu = $('.sidebar-navigation');
var link = vmenu.find('[href="' + anchor + '"]');
if (link.length === 0) {
// this link was not found in the sidebar.
@@ -144,15 +144,12 @@ function ThemeNav () {
// If we found a matching link then reset current and re-apply
// otherwise retain the existing match
if (link.length > 0) {
$('.wy-menu-vertical .current').removeClass('current');
$('.sidebar-navigation .current').removeClass('current');
link.addClass('current');
link.closest('li.toctree-l1').addClass('current');
link.closest('li.toctree-l1').parent().addClass('current');
link.closest('li.toctree-l1').addClass('current');
link.closest('li.toctree-l2').addClass('current');
link.closest('li.toctree-l3').addClass('current');
link.closest('li.toctree-l4').addClass('current');
link.closest('li.toctree-l5').addClass('current');
for (let i = 1; i <= 10; i++) {
link.closest('li.toctree-l' + i).addClass('current');
}
link[0].scrollIntoView();
}
}
+2 -8
View File
@@ -37,10 +37,10 @@ module.exports = {
loader: "sass-loader?indentedSyntax",
options: {
includePaths: [
"node_modules/bootstrap/scss",
"node_modules/bourbon/app/assets/stylesheets",
"node_modules/bourbon-neat/app/assets/stylesheets",
"node_modules/font-awesome/scss",
"node_modules/wyrm/sass"
"node_modules/font-awesome/scss"
]
}
}
@@ -66,11 +66,5 @@ module.exports = {
filename: "css/[name].css?[hash]",
chunkFilename: "css/[name].css?[hash]"
}),
new CopyPlugin([
{
from: 'node_modules/html5shiv/dist/*.min.js',
flatten: true,
to: path.resolve(__dirname,'sphinx_rtd_theme/static/js') },
]),
]
};