Compare commits

...
585 Commits
Author SHA1 Message Date
Aaron Carlisle e276b9ca5d Put js reference in if 2019-02-25 20:34:01 -05:00
Aaron Carlisle 271c3a9b70 Fixes to grunt file 2019-02-25 14:26:22 -05:00
Aaron Carlisle 5e734b4424 Remove GA from layout 2019-02-25 14:09:05 -05:00
Aaron Carlisle 62069146e3 Move ga to js file 2019-02-25 14:04:54 -05:00
Aaron Carlisle d2cd909f6b Merge branch 'master' into Blendify/fix-726 2019-02-25 13:42:13 -05:00
Aaron Carlisle 5d10a1f2fb Move logic to js 2019-02-25 13:39:10 -05:00
Aaron Carlisle 966d5e4ba7 Remove inline JS 2019-02-25 13:27:36 -05:00
Benjamin Bach 6c876607a5 Do not float elements next to admonition blocks #722 (#723) 2019-02-25 13:24:48 -05:00
Aaron Carlisle 0aae6ce01a Update grunt file after file rename 2019-02-25 13:24:21 -05:00
Aaron Carlisle 8d6ce57c87 Rename theme.js to theme.js_t 2019-02-25 13:20:15 -05:00
Aaron Carlisle c8a20f3e08 Defer search index 2019-02-25 13:19:30 -05:00
Leon Barrett ecbc09f22a Setup.py references fonts dir plural (#721)
The fonts are in `static/fonts`, but setup.py has been installing
`static/font`. That didn't seem to work for me. This changes setup.py to
match the actual directory.
2019-02-13 14:54:51 -05:00
Eric Holscher 13a9010c31 Merge pull request #710 from Juanlu001/patch-1
Bump to development version
2019-02-12 16:50:33 -03:00
Eric Holscher 7cb89be1fa Merge branch 'master' into patch-1 2019-02-12 16:44:39 -03:00
Eric Holscher a3ab477aaa Merge pull request #720 from rtfd/release-0.4.3
Release 0.4.3
2019-02-12 16:37:47 -03:00
Eric Holscher d8355ca6ae Fix docs on configuring 2019-02-12 16:34:25 -03:00
Eric Holscher ae4e8c28ec Release 0.4.3 2019-02-12 16:31:39 -03:00
Eric Holscher ed9651e678 Merge pull request #704 from jgehrcke/patch-1
footer.html: show last_updated below copyright
2019-02-12 16:26:22 -03:00
Eric Holscher dde9c37b48 Merge pull request #683 from rtfd/manifast_tests
Tests: Include Tests in Pypi distribution
2019-02-12 16:23:41 -03:00
Eric Holscher 63a4bbb522 Merge branch 'master' into manifast_tests 2019-02-12 16:21:43 -03:00
Eric Holscher 68e31e1b37 Merge pull request #674 from rtfd/agj/docs-config-updates
Much cleanup for configuration docs
2019-02-12 16:18:31 -03:00
Eric Holscher 226cf3844e Change to span. 2019-02-12 16:17:31 -03:00
Eric Holscher 675ef7d3fe Add class name 2019-02-12 16:16:25 -03:00
Eric Holscher 76c3769142 Merge branch 'master' into manifast_tests 2019-02-12 16:14:18 -03:00
Eric Holscher a81f7448fd Merge branch 'master' into agj/docs-config-updates 2019-02-12 16:12:35 -03:00
Eric Holscher c2b61e4c7d Merge pull request #703 from nokia/header-background
Change search background
2019-02-12 16:08:23 -03:00
Eric Holscher b3d090e3e4 Merge branch 'master' into manifast_tests 2019-02-12 16:07:10 -03:00
Juan Luis Cano Rodríguez 927b169f55 Bump to development version 2019-01-26 18:08:42 +01:00
Anthony Johnson dd6a095358 Review updates and more intersphinx 2019-01-22 15:20:53 -07:00
Gergely Csatari 5877f371e5 Correction of documentation comments 2019-01-07 10:26:14 +01:00
Gergely Csatari e0e40e2a64 Merge branch 'master' into header-background 2019-01-04 08:42:03 +01:00
Gergely Csatari 17691e9213 Documentation 2019-01-04 08:40:31 +01:00
Eric Holscher 3a31dba187 Merge pull request #711 from stsewd/update-travis
Remove deprecated sudo from travis
2019-01-02 19:18:21 -05:00
Santos Gallegos fa67c92aaa Remove deprecated sudo from travis
https://blog.travis-ci.com/2018-11-19-required-linux-infrastructure-migration
2019-01-02 18:36:41 -05:00
Jesse Tan 930b5ab586 Merge branch 'master' into patch-1 2018-12-21 11:23:46 +01:00
Jesse Tan 16f8cdcf49 Merge branch 'master' into header-background 2018-12-21 11:23:06 +01:00
David Fischer 73d3029932 Merge pull request #707 from dojutsu-user/add-vertical-scroll
Add vertical scroll on Footer menu
2018-12-19 08:38:48 -08:00
Gergely Csatari 476dec4422 Changing the parameter name to style_nav_header_background
Also making it to modify the background css property instead of
background-color

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
2018-12-19 16:59:45 +01:00
Jesse Tan 3f2a49d180 Merge branch 'master' into add-vertical-scroll 2018-12-19 15:37:42 +01:00
Jesse Tananddojutsu-user fe4a52b2a8 set correct value of max-height
Co-Authored-By: dojutsu-user <vaibhgupt199@gmail.com>
2018-12-19 15:55:44 +05:30
Gergely Csatari 3af8d2f664 Making the background of search configurable
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
2018-12-19 11:09:15 +01:00
dojutsu-user acc5c68b31 set max-height 2018-12-19 14:30:28 +05:30
David Fischer ab10feb6a5 Fix line endings (#709)
* Note that .bat has CRLF endings

* Remove line endings on .bat

It will be normalized correctly on checkout
2018-12-18 14:45:19 -05:00
David Fischer ceb2ef463c Merge pull request #700 from rtfd/Blendify/fix-621
Previous button float left
2018-12-18 10:54:31 -08:00
dojutsu-user 1115065090 Add vertical scroll 2018-12-18 10:44:55 +05:30
Jan-Philip Gehrcke 6635e76c5a Update changelog.rst 2018-12-15 17:59:37 +01:00
Jan-Philip Gehrcke da20d3e82e footer.html: show last_updated below copyright
Without this patch the following text can appear on the same line:

Copyright year-year, name Last updated on Mmm DD, YYY.

The additional container ensures that the last_updated notice is
placed below the copyright notice.
2018-12-15 17:52:45 +01:00
Jesse Tan 600520c39c Merge branch 'master' into agj/docs-config-updates 2018-12-12 11:44:41 +01:00
Jesse Tan ad9ef570ed Merge branch 'master' into Blendify/fix-621 2018-12-12 11:42:50 +01:00
Aaron Carlisle 2c15fde411 Lists not indented properly on genindex.html (#676)
* Lists not indented properly on genindex.html

I haven't tested this yet but it is a start to fixing this. No need to review yet.

Fixes #671

* Update CSS Selector

This should also fix #685

* Remove styling for contents
2018-12-07 21:52:45 -05:00
Aaron Carlisle 3f635171fa Update breadcrumbs.html 2018-12-07 21:46:38 -05:00
Aaron Carlisle eea17fe963 Previous button float left
Fixes #621
2018-12-04 21:09:30 -05:00
Jesse Tan 26d6108dec Fix scrolling to active item in sidebar on load (#214) (#688) 2018-12-04 20:53:16 -05:00
Aaron Carlisle a42c4d74fe Move javascript back to head (#545)
* Move javascript back to head

* Move jQuery function back to bottom

* Do not change white space

* Update comment + whitespace cleanup

* Address review points

* Fix code comments
2018-12-04 20:27:37 -05:00
Eric Holscher 7e4592f95c Add support for Google Analytics to theme. (#411)
* Add support for Google Analytics to theme.

This setting has actually existed in the default config since the original version,
but doesn't currently work.
This fixes that and supports GA if it's set.

* Add docs around analytics_id

* Do not conflict with RTD insertion of analytics script

* Remove dupliate analytics_id

* Add analytics_id to the configuration in its new place
2018-12-04 15:08:29 -05:00
Aaron Carlisle 5b7d202a11 Small visual improvement to captions in toctree (#665)
* Small visual improvement to captions in toctree

* Add new nav-caption internal var

* Use colored text and add margin

* Nav captions now have independent color

Co-Authored-By: Blendify <carlisle.b3d@gmail.com>

* De saturate the bright blue captions

Co-Authored-By: Blendify <carlisle.b3d@gmail.com>
2018-12-04 12:43:45 -05:00
Jesse Tan 139a56abee Style caption link for code and literal blocks (#690) 2018-12-04 10:41:13 -05:00
Eric Holscher b9bf19f5be Remove RTD integration now that it isn't requiremed (#684) 2018-11-30 12:11:20 -05:00
Jesse Tan 28e7c4a47a Style code block captions (#689)
* Give code block captions same permalink as other elems

* Style code block captions like table captions

* Revert "Give code block captions same permalink as other elems"

This reverts commit 4f7e6da246.
2018-11-30 12:05:18 -05:00
Jesse Tan 8e376af4fc Fix inconsistent font size and line height for autodoc "raises" and "returns" (#691) 2018-11-30 11:50:09 -05:00
Aaron Carlisle 7ea8ac1529 Tests: Include Tests in Pypi distribution 2018-10-05 15:04:58 -04:00
David Fischer 4a3d790e61 Merge pull request #655 from rtfd/davidfischer/declare-package-main
Declare the main entry point of the package
2018-10-05 11:21:24 -07:00
David Fischer 30f3635a41 Merge branch 'master' into davidfischer/declare-package-main 2018-10-05 11:15:27 -07:00
Eric Holscher 714655e610 Bump theme files for 0.4.2 2018-10-05 11:14:39 -07:00
Eric Holscher a08fe03827 Bump to 0.4.2 2018-10-05 11:14:39 -07:00
Aaron Carlisle da6d1dbb3d Tests: Update to new sphinx & python 2018-10-05 11:14:12 -07:00
Eric Holscher 40cdb8a675 Merge pull request #680 from rtfd/Blendify/update-tests
Tests: Update to new sphinx & python
2018-10-05 15:28:43 +02:00
Eric Holscher f2414868e7 Merge branch 'master' into Blendify/update-tests 2018-10-05 15:21:49 +02:00
Eric Holscher 1df9968e32 Merge pull request #682 from rtfd/release-0.4.2
Release 0.4.2
2018-10-05 15:18:13 +02:00
Eric Holscher fd404cc2d6 Merge branch 'master' into Blendify/update-tests 2018-10-05 13:59:22 +02:00
Eric Holscher 13d2e608ef Bump theme files for 0.4.2 2018-10-05 13:31:07 +02:00
Eric Holscher 04994af769 Bump to 0.4.2 2018-10-05 13:31:07 +02:00
Eric Holscher c034d48f44 Merge branch 'master' into davidfischer/declare-package-main 2018-10-05 13:21:48 +02:00
Eric Holscher df33248b40 Merge pull request #678 from rtfd/Blendify/4.2-changelog
Update changelog.rst
2018-10-05 13:19:42 +02:00
Eric Holscher 46a30df96e Merge branch 'master' into davidfischer/declare-package-main 2018-10-05 13:18:35 +02:00
Eric Holscher 238f586b8e Update date 2018-10-05 13:16:29 +02:00
Aaron Carlisle 95b2fdd84f Fix Grammar 2018-10-01 13:09:16 -04:00
Aaron Carlisle d75745736a Tests: Update to new sphinx & python 2018-10-01 11:05:35 -04:00
Aaron Carlisle 965c6f305c Update changelog.rst 2018-10-01 11:00:39 -04:00
Takeshi KOMIYA ebbf3d1697 Fix HTML search not working with Sphinx-1.8. (#672)
* Fix HTML search not working

Since Sphinx-1.7, Sphinx has exported search options as
`documentation_options.js`.  This starts to refer it instead of
definitions of JavaScript variables.
In addition, this also uses `js_tag()` function which added in 1.8
to support additional attributes for scripts (ex. async attribute).

* Add code comment
2018-10-01 10:49:31 -04:00
Anthony Johnson 31b7c3b46a Much cleanup for configuration docs
* Clean up a lot of copy.
  * Reduce usage of internal Sphinx concepts like "toctree"
  * Make language clearer
  * Fix a few factual inaccuracies
  * Remove noisey/placeholder/introduction to a paragraph sort of text,
    this just distracts readers.
* Make `confval` domain role to allow for creation of config value field
  lists that are linkable and can be referenced. Also include
  type/default fields
* Reduce redundancy in heading
* Intersphinx to Sphinx docs
* Use new role to intersphinx to Sphinx confvals
* Add copy on using logo/etc. These are common questions for us for
  those not familiar with Sphinx. Link to appropriate docs.
2018-09-26 14:35:45 -06:00
Jesse Tan 310043695f Set base font size on <html> (#668) 2018-09-17 17:28:04 -04:00
Jakub Kadlčík 6bed095f14 Avoid printing dot when copyright holder already ends with dot (#666)
e.g. My Company, Inc.
2018-09-16 19:58:43 -04:00
David Fischer 74ba4b29fb Upload signed packages to PyPI with twine (#651)
* Upload signed packages to PyPI with twine

* Delete previous distributions
2018-08-23 17:56:43 -04:00
Eric Holscher 4fc72d97ed Merge pull request #663 from kwshaw1/patch-1
Fixing minor typo
2018-08-08 22:41:25 +02:00
Kevin Shaw 4c53dd0454 Fixing minor typo
Changed "primary" to "primarily" in first paragraph.
2018-08-08 09:15:23 -07:00
Anthony f20bfa5882 Merge pull request #662 from rtfd/davidfischer/release-0.4.1
Release v0.4.1
2018-07-27 11:30:04 -06:00
David Fischer 521820c9bf Release v0.4.1 2018-07-27 10:18:29 -07:00
David Fischer 80860e36db Merge branch 'master' into davidfischer/declare-package-main 2018-07-27 10:10:16 -07:00
David Fischer c190ea2095 Merge pull request #657 from rtfd/adjust-codeblock-lineheight
Adjust codeblock lineheight
2018-07-27 10:09:53 -07:00
Jesse Tan 0455178ac3 Update changelog 2018-07-04 10:12:45 +02:00
Jesse Tan de248e225c Set line-height for conisitent look of Liberation Mono 2018-07-04 10:12:36 +02:00
David Fischer c960976f90 Declare the main entry point of the package 2018-06-28 12:21:06 -07:00
Jesse Tan b82993dfdb Add Sphinx as a dependency (#652) 2018-06-18 22:16:44 -04:00
David Fischer 5a16288abc Merge pull request #649 from rtfd/version-0.4.0
Version 0.4.0 updates
2018-06-06 12:59:40 -07:00
David Fischer 69fafa2e0a Version 0.4.0 updates 2018-06-06 11:09:22 -07:00
Eric Holscher 53e2a78457 Merge pull request #614 from rtfd/always-bundle-js-css
Always bundle the theme CSS/JS
2018-05-31 15:13:24 -04:00
David Fischer 4b45725f68 Merge branch 'master' into always-bundle-js-css 2018-05-31 12:04:01 -07:00
Jesse Tan 0051b91014 Change Lato font to webfont (version 2.015) (#639)
* Change Lato font to webfont version 2.015

* Fix missing eot, woff and woff2 statement for Lato regular

* Remove reference to non-existing SVG font
2018-05-24 11:49:40 -04:00
Jesse Tan 9fdadd5a6f Bundle Roboto Slab as a real web font (not just ttf) (#642) 2018-05-24 11:33:57 -04:00
David Fischer 17ecdc6839 Merge pull request #638 from rtfd/increase-color-accessibility
Accessibility improvements to the left nav
2018-05-18 07:22:00 -07:00
David Fischer ece48667b9 Merge branch 'master' into increase-color-accessibility 2018-05-15 15:06:37 -04:00
David Fischer 77f003e3d9 Merge pull request #606 from rtfd/version-in-js
Write theme version at the top of theme.js and thems.css
2018-05-15 15:00:33 -04:00
David Fischer 7e3a380f2b Merge branch 'master' into version-in-js 2018-05-15 14:33:28 -04:00
David Fischer 34cc4a2aec Merge pull request #616 from rtfd/pad-literal-blocks
Add padding to parsed literal blocks
2018-05-15 14:32:09 -04:00
David Fischer 6a5d4908eb Merge branch 'master' into version-in-js 2018-05-15 14:11:28 -04:00
David Fischer d8318dae41 Merge branch 'master' into pad-literal-blocks 2018-05-15 14:11:01 -04:00
David Fischer 6c62b4002c Merge pull request #612 from rtfd/davidfischer/native-code-font-stack
Switch to a native code font stack
2018-05-15 14:10:24 -04:00
David Fischer 23094a4ff6 Merge branch 'master' into davidfischer/native-code-font-stack 2018-05-15 14:06:41 -04:00
David Fischer 5f9ec36d6e Merge pull request #635 from rtfd/bottom-margin-in-tables
Prevent extra whitespace at bottom of some table cells
2018-05-15 14:05:45 -04:00
David Fischer 1b43a8ec5c Merge branch 'master' into bottom-margin-in-tables 2018-05-15 13:41:50 -04:00
David Fischer 8e86b27626 Merge pull request #632 from rtfd/line-block-spacing
Give line blocks the same line height as regular text
2018-05-15 13:41:33 -04:00
David Fischer 9d5704398c Merge branch 'master' into line-block-spacing 2018-05-15 13:03:54 -04:00
David Fischer 9fea68aa1d Merge pull request #631 from rtfd/definition-list-spacing
Increase definition list spacing
2018-05-15 13:03:38 -04:00
David Fischer 44de961597 Merge branch 'master' into definition-list-spacing 2018-05-15 12:57:37 -04:00
David Fischer 0bd591e20c Slightly darken the left nav captions 2018-05-15 09:19:53 -07:00
David Fischer 1ba882cf87 Accessibility improvements to the left nav 2018-05-14 15:30:52 -04:00
Jesse Tan 45949bf339 Make disablig sticky nav work again (#634) 2018-05-08 14:23:41 -04:00
Jesse Tan bdd313a2aa Prevent extra whitespace at bottom of some table cells 2018-05-08 16:42:28 +02:00
Jesse Tan f17c94cb0f Give line blocks the same line height as regular text 2018-05-07 13:40:44 +02:00
Jesse Tan fe9214040c Update changelog 2018-05-07 13:18:17 +02:00
Jesse Tan 302f4c3158 Increase spacing beneath dt 2018-05-07 13:10:03 +02:00
Jesse Tan e21c5ab2fb Give one paragraph dd same lineheight as multiple paragraph ones 2018-05-07 13:09:54 +02:00
Jesse Tan f9e653f5bf Merge branch 'master' into version-in-js 2018-05-04 11:05:59 +02:00
Jesse Tan 2d011031a4 Merge branch 'master' into pad-literal-blocks 2018-05-04 11:02:46 +02:00
Jesse Tan 141e3283fa Merge branch 'master' into davidfischer/native-code-font-stack 2018-05-04 11:02:20 +02:00
Anthony 55536dea2b Merge pull request #628 from rtfd/agj/0.3.1-one-more-time
Update assets for 0.3.1
2018-05-01 16:13:00 -06:00
Anthony Johnson 0fc3a64821 Update assets for 0.3.1 2018-05-01 16:09:25 -06:00
Anthony d708e47793 Merge pull request #627 from rtfd/agj/release-0.3.1-again
Update changelog
2018-05-01 15:56:11 -06:00
Anthony Johnson 2f438d5665 Update changelog 2018-05-01 15:49:31 -06:00
Anthony f6124366c5 Merge pull request #626 from rtfd/remove-overflow-y
Remove overflow
2018-05-01 15:43:26 -06:00
David Fischer 8c85a5e2f6 Remove overflow 2018-05-01 14:37:21 -07:00
Anthony ab2196823a Merge pull request #625 from rtfd/release/0.3.1
Prepare release 0.3.1
2018-05-01 15:00:31 -06:00
Anthony Johnson 801c0bf279 Bump versions 2018-05-01 13:54:10 -06:00
Anthony Johnson 9a07ca465f Prepare release 0.3.1
This is a bugfix release that addresses some minor styling fixes and
compatibility with mkdocs and previous version theme layout.html.
2018-05-01 13:51:08 -06:00
Anthony 41ab3d2ecb Merge pull request #623 from rtfd/release-0.3.1
Add backwards compatiblity for pre 0.3.0 layout.html files
2018-05-01 13:45:54 -06:00
Anthony e3a0b54c0f Merge branch 'master' into release-0.3.1 2018-05-01 13:26:39 -06:00
David Fischer 88aa0524d9 Merge pull request #622 from rtfd/mkdocs-version-selector-fix
Fix for mkdocs version selector
2018-05-01 08:41:04 -07:00
Jesse Tan d7ab275f8f Merge branch 'master' into davidfischer/native-code-font-stack 2018-05-01 09:49:19 +02:00
Anthony Johnson 68040a1a53 Add backwards compatiblity for pre 0.3.0 layout.html files
Until we have broken up the theme javascript/css and the files served by Read
the Docs, backwards compatiblility is required in all changes to javascript.
This reverts some of the changes in 0.3.0 around our javascript.
2018-04-30 16:38:21 -06:00
David Fischer b8fb89b551 Fix for mkdocs version selector 2018-04-30 11:45:30 -07:00
David Fischer 92f0065ef4 Merge branch 'master' into always-bundle-js-css 2018-04-23 10:32:35 -07:00
David Fischer 41d08ee8c8 Update changelog 2018-04-23 10:31:34 -07:00
Santos Gallegos 2dfbc64e0e Remove default value for vcs_pageview_mode (#617)
This variable is used on the template and evaluated to
give a default value.

According to http://jinja.pocoo.org/docs/2.10/templates/#default
default only works if the variable is undefined,
or passing true as second argument to evaluate to false.
2018-04-23 08:29:25 -04:00
David Fischer d4310977d8 Updated changelog for clarity 2018-04-20 09:19:02 -07:00
Jesse Tan 0fde3ab093 Add padding to literal blocks 2018-04-20 16:51:56 +02:00
David Fischer 41d251a706 Always bundle the theme CSS/JS 2018-04-17 23:11:02 -07:00
David Fischer a07d466ba8 Apply the code font more broadly 2018-04-17 11:33:19 -07:00
David Fischer 1f54624f09 Changes based on feedback 2018-04-17 11:04:35 -07:00
David Fischer a233c9fb7d Switch to a native code font stack 2018-04-16 16:43:30 -07:00
Jesse Tan 425be95d46 Fix typo 2018-04-16 11:40:18 +02:00
Jesse Tan 6874c380f5 Update changelog 2018-04-15 16:07:23 +02:00
Jesse Tan 13ab16513c Also add to CSS 2018-04-15 16:06:01 +02:00
Jesse Tan b25fdd1549 Use comment style suitable for JS and CSS 2018-04-15 16:05:53 +02:00
Aaron Carlisle 049a1a01da Merge branch 'master' into version-in-js 2018-04-13 12:12:52 -04:00
Aaron Carlisle 7cd846b4fd Docs: correct navigation_depth discription (#609)
* Docs: correct navigation_depth discription

* Docs: add note about large toctrees

* Docs: Cleanup: use different note markup

Github does not mark the syntax correctly otherwise
2018-04-11 22:04:32 -04:00
Mike Edmunds bb82cd22fd Add spacing between items in "open" lists (#591)
Override wyrm's `... li p:last-child { margin-bottom: 0 }` from .wy-plain-list-disc and .wy-plain-list-decimal.

Fixes #590. (And probably #354.)
2018-04-11 21:46:06 -04:00
Jesse Tan b97a7ee445 Fix centered tables (#601)
* Fix centered tables

Centered elements get `display: block` which does not work with tables. This commit excepts tables, so they will still use `display: table` and center properly
Fixes #599.

* Update changelog
2018-04-11 19:08:30 -04:00
Jesse Tan 8551188ad6 Make code block line emphasis span entire line (#608) 2018-04-11 08:20:19 -04:00
Jesse Tan e90db838ce Write theme version at the top of theme.js 2018-04-10 13:48:11 +02:00
Anthony af3ff632f1 Merge pull request #602 from rtfd/agj/add-rtd-yml
Add readthedocs.yml for per-tag/branch configuration
2018-04-05 13:44:53 -06:00
Anthony Johnson 821b13066e Add readthedocs.yml for per-tag/branch configuration 2018-04-05 13:40:04 -06:00
Aaron Carlisle 30b57e66d3 Set collapse_navigation to true (#600)
This matches 0.2.4 behavior. Although it might not be desired behavior, the behavior of setting this to true can result in file size to explode and build times also.

This was caused by bf9faa98f0 which effectly switched the logic of `collapse_navigation`
2018-04-02 13:31:22 -04:00
Anthony 7661231a7e Merge pull request #597 from rtfd/agj/changelog-0.3.0
Update changelog to 0.3.0 for release
2018-03-30 10:30:47 -06:00
Anthony 4c99c1013a Merge branch 'master' into agj/changelog-0.3.0 2018-03-30 10:21:10 -06:00
Anthony c96a1b8500 Merge pull request #596 from rtfd/agj/rebuild-assets-0.3
Rebuild assets
2018-03-30 10:20:56 -06:00
Anthony 93cbcd89d2 Merge branch 'master' into agj/rebuild-assets-0.3 2018-03-30 09:59:10 -06:00
Anthony f935c22163 Merge pull request #595 from rtfd/agj/add-bower
Add bower to dev depends
2018-03-30 09:58:42 -06:00
Anthony Johnson dbb68468da Might as well update the version in other places too 2018-03-29 18:58:12 -06:00
Anthony Johnson 5732cfa06c npm didn't save as dev depend 2018-03-29 18:33:12 -06:00
Anthony Johnson 9fbbaa9f63 Update changelog to 0.3.0 for release
Next release is 0.3.0 based on semver
2018-03-29 18:32:12 -06:00
Anthony Johnson c43d473cb5 Rebuild assets 2018-03-29 18:21:24 -06:00
Anthony Johnson 5d3ebf5241 Add bower to dev depends
All of our dependencies should be specified, we don't rely on global installs
anywhere with node modules.
2018-03-29 18:20:23 -06:00
Anthony 47efcfec01 Merge pull request #532 from rtfd/foldable-local-toc
Do not make local-toc contents always visible
2018-03-29 17:44:13 -06:00
Anthony 8cf3a8db30 Merge branch 'master' into foldable-local-toc 2018-03-29 17:35:01 -06:00
Jesse Tan c94af91965 Do not allow selection of line numbers in code blocks (#594) 2018-03-25 08:08:02 -04:00
Jesse Tan 7dbbcdc221 Add color to all th borders (#593)
Fixes 581
2018-03-23 10:42:39 -04:00
Aaron Carlisle 3eebd9a2e7 Replace the name 'Dave Snider' with RTD (#572)
* Replace the name 'Dave Snider' with RTD

* Address review

* Give credit back to Dave + RTD
2018-03-19 07:56:34 -04:00
zprd b379d70ecf use id to find the future current sidebar item (#586)
Fixes #583

- find the referenced 'id element' first, then the closest section
- if no association found in the sidebar, fallback to #
- reword comments
2018-03-18 12:40:45 -04:00
Aaron Carlisle bc6e0e8ddd Docs: fix broken link (#569)
* Fix errors in recent commit

* Go back to intersphinx link
2018-03-07 10:32:01 -05:00
Aaron Carlisle 146457a6c8 Docs: restructure (#573)
The idea here is to make the docs have a more flat design that exposes more pages from the main index.
2018-03-01 10:15:53 -05:00
Jakub Wilk 31f743ae93 Docs: Fix typos (#584) 2018-02-28 17:53:23 -05:00
Anthony 6d0136fd69 Merge pull request #577 from rtfd/content-block
Add a block around the page content
2018-02-27 11:57:12 -07:00
Anthony 38c46ce153 Merge branch 'master' into content-block 2018-02-27 11:48:48 -07:00
ederag 60fff9cbeb add missing quotes (bottom should be a string) (#580) 2018-02-20 14:48:48 -05:00
David Fischer ef0e6c2e89 Merge pull request #579 from ederag/patch-1
Typo: Contibuting => Contributing
2018-02-20 10:55:05 -08:00
ederag ddeecd9e98 Typo: Contibuting => Contributing 2018-02-20 19:42:39 +01:00
Aaron Carlisle e001f8d149 Merge branch 'master' into content-block 2018-02-17 20:18:47 -05:00
Jesse Tan 7c98fbc936 Allow versions popup to scroll (#576)
* Make rst-versions scrollable when expanded

* Remove top border

* Do not use entire height unless necessary
2018-02-17 10:46:52 -05:00
Aaron Carlisle ac910bb739 Add document block and rename bodycontent content 2018-02-15 09:47:29 -05:00
Aaron Carlisle 178e94aca8 Add a block around the page content
This can be used to easily write custom content pages
2018-02-14 21:38:32 -05:00
Jesse Tan 24a7000334 Docs: httpdomain package name uses dash instead of period 2018-02-08 09:42:11 -05:00
Aaron Carlisle 581808b638 Update changlog for 0.2.5 (#570)
* Update changlog for 0.2.5

* Changelog: fix typos
2018-02-06 16:45:55 -05:00
Aaron Carlisle 132e3fa394 Run Grunt (#568) 2018-02-06 14:56:10 -05:00
Aaron Carlisle 7ebe5c8739 Create CODE_OF_CONDUCT.md (#562)
* Create CODE_OF_CONDUCT.md

* Point to the RTD code of conduct

* Docs: Add intersphinx

* Docs: add link to our code of conduct

* Add missing sphinx link
2018-02-02 18:43:18 -05:00
jpsenior 04520a0476 #463 - Add github, gitlab, bitbucket page arguments option (#464)
This currently defaults to current behavior but can be changed with `vcs_pageview_mode`
2018-01-31 21:46:14 -05:00
Eric Holscher 7b57c074a8 Merge pull request #564 from rtfd/remove-typekit
Remove theme_typekit
2018-01-31 07:19:53 -08:00
Aaron Carlisle b68cd8d4ab Remove from theme.conf 2018-01-30 15:09:12 -05:00
Aaron Carlisle 1e6e1049a1 Remove from docs 2018-01-30 15:08:38 -05:00
Aaron Carlisle c410ee2547 Update footer.html (#561) 2018-01-29 21:37:40 -05:00
Aaron Carlisle 67bb54d450 Refactor docs: split up & slim down read me
Fixes #557 #523

* Remove old conf file setup

* Split changelog to its ownfile

* Remove changelog from readme

* Update introduction sentence

* Fix wording of intro

* Remove readme table of contents

* Move links to there sections

* Remove config

* Create configuring.rst

* Remove todo

* Remove installing docs from readme

* Create installing.rst

* Remove contributing section from readme

* Create contributing.rst

* Include basic info in readme

The rest gets pointed to our actual docs

* Add new files to toctree

* Fix configuring options title

* Set logo_only to True

  Also, remove documentation of theme options. We have actual docs for this.

* Include readme on index page
2018-01-29 20:44:03 -05:00
Aaron Carlisle 419c6f57c3 Fix #305 Move 1400px media-query to 1100px (#396)
* Use sass var for content max width

* Add new theme vars

* Use own media screen

* Update patch with the ability to chnage the side bar width and content width

There is still a bug were the centent width fills the full screen.
This will have to be fixed before merging.

* Use javascript instead

* Run grunt build

* Remove the ability to set sidebar width

* Revert "Remove the ability to set sidebar width"

This reverts commit 3ad5b5b99a.

* Revert "Run grunt build"

This reverts commit f3f9ff9dc1.

* Revert "Use javascript instead"

This reverts commit 630b50fd61.

* Revert "Update patch with the ability to chnage the side bar width and content width"

This reverts commit f928c3350a.
2018-01-25 10:28:10 -05:00
Jesse Tan f2e8a23112 Only output div.articleComments if the block has content (#555) 2018-01-24 10:13:08 -05:00
Jesse Tan abd951a9cd Readme cleanup (#554)
* Move badges below title

* typekit_id is a string

* Fix some text uninententionally bold

* More accurately describe install

* Proper italics instead of non-working underline

* MD style inline code to rst style

* hidden is a :property:
2018-01-24 09:44:42 -05:00
Aaron Carlisle 54d62483bf Add GitHub templates (#410)
* Add issue template

* Move contributing docs into there own file

* Delete CONTRIBUTING.md

* Address Review

- Style the code block with `rst`
- Add python version
2018-01-23 10:24:47 -05:00
David Fischer 25fb424668 Merge pull request #380 from rtfd/fix-273
Fix #273 line-block: set the left margin to 0px
2018-01-20 19:28:21 -08:00
David Fischer 83c64a5df8 Merge branch 'master' into fix-273 2018-01-20 13:00:05 -08:00
Aaron Carlisle 3bdf6ac7d7 Remove leftover compass files (#552)
* Delete Gemfile.lock

* Delete Gemfile

* Update README.rst
2018-01-19 11:33:20 -05:00
Aaron Carlisle c0b494ea84 Allow setting 'rel' and 'title' attributes for stylesheets (#551)
See https://github.com/sphinx-doc/sphinx/commit/618ef6492c89c50f263c4c6c5794e40e35f91be8
2018-01-18 16:37:14 -05:00
Aaron Carlisle 6f5d0d965f Cleanup: Long lines (#549) 2018-01-18 13:46:26 -05:00
Aaron Carlisle 7d4c109637 Remove "up" and "top" rel attributes + code cleanup (#548)
See https://github.com/sphinx-doc/sphinx/commit/d43259f5f748cd00eba168b54b7b798d3f257911
2018-01-18 13:23:42 -05:00
Aaron Carlisle ed48532da6 Add alt to logo img (#550) 2018-01-18 13:10:51 -05:00
David Fischer b4ab3f6714 Merge pull request #531 from rtfd/grunt-uglify
Uglify during build
2018-01-16 09:25:49 -08:00
David Fischer 3a3da60035 Merge branch 'master' into grunt-uglify 2018-01-16 08:38:43 -08:00
David Fischer 266bc65871 Merge pull request #517 from rtfd/fix-516
Correctly change current link in toctree if toplevel headers are on same page
2018-01-16 08:37:00 -08:00
David Fischer d6bc4c6daf Merge branch 'master' into grunt-uglify 2018-01-16 08:35:25 -08:00
Jesse Tan 0bc0969619 Concisify 2018-01-16 09:56:18 +01:00
Jesse Tan 387d4123b5 Merge branch 'master' into fix-516 2018-01-16 09:37:36 +01:00
David Fischer 67e0b98174 Merge pull request #413 from rtfd/caption-margin
Set margin-bottom to 0 for captions in figures
2018-01-15 17:14:05 -08:00
Aaron Carlisle 1f92024984 Update css selector 2018-01-15 20:00:07 -05:00
David Fischer 864abcc0d0 Merge branch 'master' into caption-margin 2018-01-15 16:32:10 -08:00
David Fischer 2e09b4f2be Merge pull request #513 from rtfd/fix-459
Do not add border to active links with level >1
2018-01-15 14:22:22 -08:00
David Fischer e6c8a7163e Merge branch 'master' into fix-459 2018-01-15 14:16:13 -08:00
Aaron Carlisle 5062c200d6 Do not set the default role for the body tag (#542)
* Do not set the default role for the body tag

See https://www.w3.org/TR/html5/sections.html#the-body-element And:
https://github.com/sphinx-doc/sphinx/pull/3495

* Remove nav role from nav tag
2018-01-15 16:09:24 -05:00
Aaron Carlisle 636f37ae67 Remove base64 background image (#537)
* Remove base64 background image

* Address review comments
2018-01-15 16:01:02 -05:00
David Fischer 3af3c29c14 Merge branch 'master' into fix-273 2018-01-15 11:40:58 -08:00
David Fischer dcc93ab610 Adjust margins on top level and nested line-blocks
- top level have no left margin and a bottom margin
- nested have a left margin and no bottom margin
2018-01-15 11:25:38 -08:00
Aaron Carlisle d3326461e5 Remove wyrm_addons/pygments (#504)
* Remove wyrm_addons/pygments/
* Use own sass for codeblocks
* Fix styling of code blocks
* Set line height for all
* Revert back to normal line height
* Group css rules to keep them in sync
2018-01-14 15:40:41 -05:00
Aaron Carlisle b5b351cf6c Merge branch 'master' into grunt-uglify 2018-01-14 15:34:03 -05:00
Jesse Tan 124e61ce8f Remove mathjax_path override (#534)
* Remove mathjax_path override

* Re-remove mathjax_path override
2017-12-30 14:45:16 -05:00
Jesse Tan c605f255b1 Merge branch 'master' into grunt-uglify 2017-12-29 16:23:57 +01:00
Jesse Tan 067a6794f0 Match minor dependency version for consistency 2017-12-29 16:23:17 +01:00
Jesse Tan 06e0a43333 Do not warn about using external images (#533) 2017-12-28 12:06:47 -05:00
Jesse Tan c89d524641 Do not make local-toc contents always visible 2017-12-28 11:11:31 +01:00
Jesse Tan bf848802a6 Uglify during build 2017-12-28 10:22:16 +01:00
Aaron Carlisle 19b22ebada 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
2017-12-27 21:33:02 -05:00
Aaron Carlisle 9f84648007 Docs: Add windows make file (#528) 2017-12-24 12:40:44 -05:00
Jesse Tan 7b7ccadecc Remove font task (#526) 2017-12-22 16:13:40 -05:00
Eric Holscher b2c8c0cffc Merge pull request #518 from rtfd/grunt-tasks
Make Gruntfile more foolproof
2017-12-22 08:53:18 -08:00
Aaron Carlisle 813a321117 Merge branch 'master' into fix-459 2017-12-21 16:55:14 -05:00
Aaron Carlisle fce6005b42 Merge branch 'master' into grunt-tasks 2017-12-21 09:28:00 -05:00
Eric Holscher 38ba3fc3ed Remove image from readme, and link demo to site (#521) 2017-12-21 09:27:44 -05:00
Eric Holscher 1695f89cf8 Merge pull request #520 from rtfd/docs2.0
Docs 2.0
2017-12-20 20:41:47 -08:00
Eric Holscher 6392329d34 With deps 2017-12-20 20:39:13 -08:00
Eric Holscher 161cb8b67f More sphinx 2017-12-20 20:39:01 -08:00
Eric Holscher 612788d8e1 No double build 2017-12-20 20:37:27 -08:00
Eric Holscher 72003513aa Add docs to travis 2017-12-20 20:36:52 -08:00
Eric Holscher 8e4167e364 Add badge 2017-12-20 20:31:48 -08:00
Eric Holscher 38162920b4 More cleanup 2017-12-20 20:29:52 -08:00
Eric Holscher 6e6a8729ca Lots of cleanup 2017-12-20 20:16:03 -08:00
Eric Holscher c287759d7f Merge remote-tracking branch 'origin/master' into docs2.0 2017-12-20 20:09:52 -08:00
Eric Holscher 56bffcb8fb Rejigger 2017-12-20 20:09:36 -08:00
Aaron Carlisle 6278079307 Merge pull request #512 from rtfd/fix-511
Prevent footnote and citation references changing line spacing
2017-12-20 19:04:16 -05:00
Aaron Carlisle 8088eb718b Merge branch 'master' into fix-511 2017-12-20 18:58:27 -05:00
Jesse Tan 5db94ebf5f Always call nav.enable() to make nav collapsable (#519)
Always call nav.enable() to make nav collapsing work
2017-12-20 18:50:10 -05:00
Aaron Carlisle 117be8e186 New documentation structure
This splits the docs from the demo so that we can now actually document
the theme and its parts.
2017-12-20 18:19:03 -05:00
Jesse Tan b663e20bd0 Clean all output before default task 2017-12-20 10:42:36 +01:00
Jesse Tan 748a05c697 Copy fonts to output on default and build task
Prevents missing fonts after clean
2017-12-20 10:41:54 +01:00
Jesse Tan 5d9e3a5ef9 Do not remove Modernizr during cleaning 2017-12-20 10:41:01 +01:00
Jesse Tan 6878cfd465 Clean everything before building 2017-12-20 10:31:43 +01:00
Jesse Tan 1de225c111 Add additional clean tasks 2017-12-20 10:31:31 +01:00
Aaron Carlisle 543beb01b8 Merge branch 'master' into fix-459 2017-12-19 10:52:16 -05:00
Jesse Tan 5de02b5a1a Set language of demo documentation (#515) 2017-12-19 07:38:54 -05:00
Jesse Tan 9b30e1b793 Correctly change current link in toctree if toplevel headers are on same page
Fixes #516
2017-12-19 12:47:42 +01:00
Jesse Tan 079faa00d3 Do not add border to active links with level >1 2017-12-18 16:06:21 +01:00
Aaron Carlisle c1fca38f55 Add navigation_depth to readme docs (#508)
Fixes #231
2017-12-18 09:35:13 -05:00
Aaron Carlisle 9029f27b96 Merge branch 'master' into caption-margin 2017-12-18 09:02:17 -05:00
Jesse Tan 8355c2162f Do not interefere with line-height 2017-12-18 14:24:14 +01:00
Jesse Tan bb978c0574 Prevent footnote and citation references changing line spacing 2017-12-18 14:15:29 +01:00
Aaron Carlisle 90dce37ce1 Run grunt fonts (#506)
Fixes #442
2017-12-17 16:44:15 -05:00
Aaron Carlisle cebf127615 Remove !important for image size (#505)
Fixes #318
2017-12-17 16:37:07 -05:00
Aaron Carlisle ceef969fb1 Update _theme_rst.sass (#509)
Fix #482
2017-12-17 16:30:34 -05:00
Aaron Carlisle a48eb90130 Merge branch 'master' into caption-margin 2017-12-16 16:32:41 -05:00
Paul bf9faa98f0 Add titles_only option to the toc (#456)
* Add titles_only option

* Add titles_only to readme

* Add titles_only to readme

* Convert Strings to bool

Fixes #312
2017-12-16 00:15:39 -05:00
Aaron Carlisle 01dfcff1b6 Merge branch 'master' into caption-margin 2017-12-16 00:12:09 -05:00
Dmitry Shachnev e9db692de0 Style headerlinks for table captions properly (#454)
* Style headerlinks for table captions properly

Fixes #437

* Make .headerlink code work with center-aligned elements

* Lowered font size for table headerlink as requested in the review
2017-12-16 00:09:05 -05:00
Jesse Tan a4b8eb468d Footnote citation spacing (#488)
* Do not wrap footnotes or citations to make them responsive

* Remove margin below footnotes and citations, add margin-top to next element

* Remove margin-bottom from responsive citation and footnote wrapper

* Mark responsive wrapper if used for citation or footnote

* Document workaround for footnote and citation spacing

* Add vertical space if citation/footnote is last element in parent

This keeps correct vertical whitespace if the citation or footnote is the last element in a section.
The style rule directly above this line did not match since there is direct sibling.

* Clarify

Fixes #488
2017-12-15 23:48:25 -05:00
Eric Holscher 59a37b3af9 Merge pull request #499 from rtfd/fix-stickynav-default
Default stickynav to on properly.
2017-12-15 10:56:10 -08:00
Eric Holscher 8be825a8ae Merge branch 'master' into fix-stickynav-default 2017-12-15 10:44:47 -08:00
Jesse Tan a765112b48 Do not create source map for production builds (#502) 2017-12-13 10:01:51 -05:00
Eric Holscher 9aec9a9340 Add proper options docs 2017-12-12 12:33:51 -08:00
Eric Holscher 07b25220a3 Default stickynav to on properly.
This is documented as being on,
but previously we weren't running `tobool` on it to check it properly.
This had the effect of always returning True unless the user set it to False in Python.

You can see the commit that changed it here: https://github.com/rtfd/sphinx_rtd_theme/pull/496/files#diff-1336f80431f476a232e3c48abb277c51R210

This properly defaults it to True,
so that navigation works :)
2017-12-12 12:25:36 -08:00
Eric Holscher d756528ba1 Merge pull request #496 from rtfd/fix-external-display
Fix theme logic and rebuild prod assets
2017-12-12 12:02:24 -08:00
Eric Holscher c19a5e4f54 Convert strings to bool 2017-12-11 07:48:50 -08:00
Eric Holscher a0b2ccc3f7 Fix theme logic and rebuild prod assets 2017-12-08 08:25:22 -08:00
Eric Holscher 3c1a1bbc84 Merge pull request #492 from jessetan/raf-scroll
Debounce scroll and resize through rAF
2017-12-08 07:24:10 -08:00
Eric Holscher 64ddc8f9d7 Merge branch 'master' into raf-scroll 2017-12-08 07:02:08 -08:00
Eric Holscher e25871da86 Merge pull request #493 from rtfd/beta-2
Bump to 0.2.5b2, for QA testing before release
2017-12-08 07:01:35 -08:00
Eric Holscher 5e89f4a9c0 Merge branch 'master' into beta-2 2017-12-08 06:49:32 -08:00
Eric Holscher b40d5e8c50 Merge pull request #494 from jessetan/style-external-links-option
Add option to style external links
2017-12-08 06:47:45 -08:00
Eric Holscher 42097c0193 Merge branch 'master' into beta-2 2017-12-07 12:43:21 -08:00
Jesse Tan 5c03c8da83 Add rAF polyfill 2017-12-06 12:55:20 +01:00
Jesse Tan 237289320d Remove need for bind() 2017-12-06 10:10:39 +01:00
Jesse Tan f76772c4e6 Add option to toggle style external links 2017-12-05 10:59:15 +01:00
Jesse Tan 6a3371b9a8 Use margin instead of space to keep icon next to link 2017-12-05 10:35:23 +01:00
Jesse Tan e44b885506 Enable styling of external links 2017-12-05 10:34:35 +01:00
Jesse Tan 35143f50e8 Document option 2017-12-05 10:33:58 +01:00
Eric Holscher 1266936100 Merge branch 'master' into raf-scroll 2017-12-03 09:30:50 -08:00
Eric Holscher 6c2302472f Merge pull request #448 from rtfd/fix-pygments
Fix #166: Add missing pygments css link
2017-12-03 09:30:37 -08:00
Aaron Carlisle 7df96c0d15 Merge branch 'master' into fix-pygments 2017-12-03 12:07:37 -05:00
Eric Holscher f6b8005077 Bump to 0.2.5b2, for QA testing before release 2017-12-02 14:55:29 -08:00
Aaron Carlisle 0c9f968e8e Merge branch 'master' into raf-scroll 2017-12-02 10:05:19 -05:00
Eric Holscher d746572bb2 Merge pull request #487 from jessetan/breadcrumbs-clearfix
Apply clearfix on breadcrumbs
2017-12-01 07:41:10 -08:00
Jesse Tan f79285927c Debounce scroll and resize through rAF 2017-12-01 16:13:33 +01:00
Anthony 26fbabe346 Merge branch 'master' into breadcrumbs-clearfix 2017-12-01 00:16:10 -07:00
Aaron Carlisle 12ab978aa8 Add pygments_style to theme.conf 2017-11-30 13:46:01 -05:00
Aaron Carlisle bb9ef27225 Merge branch 'master' into fix-pygments 2017-11-30 13:15:08 -05:00
Eric Holscher 2eb941519c Merge pull request #489 from rtfd/includehidden_option
Fix #485 Add Includehidden theme option
2017-11-28 11:00:50 -08:00
Aaron Carlisle 052b3952bd Document new theme option 2017-11-28 13:27:44 -05:00
Aaron Carlisle 6da7eb9747 Merge branch 'master' into fix-pygments 2017-11-25 09:57:16 -05:00
Aaron Carlisle d493463d88 Add option to layout.html 2017-11-22 11:31:48 -05:00
Aaron Carlisle 3018c7bb9b Update theme.conf 2017-11-22 11:29:37 -05:00
Jesse Tan b43f5cdafb Apply clearfix on breadcrumbs 2017-11-22 10:50:55 +01:00
Peter McDonnell 9d704f287a Follow-up grunt for #472 (#476)
* grunt run

* regenerate theme css
2017-10-14 23:24:40 -04:00
Peter McDonnell ee4d440375 Only change current if a matching link is found (#472) 2017-10-12 21:55:09 -04:00
Aaron Carlisle 896fe3ee16 Add a couple of badge icons to readme (#471) 2017-10-02 18:46:41 -04:00
Aaron Carlisle dafcbd3505 Add Sphinx Framework for PyPi (#470) 2017-10-02 18:07:24 -04:00
Aaron Carlisle dc16292ec5 Fix error in setup entry points (#466)
* Fix error in setup entry points

  This was missing from b3225c5566

* Add comment about what setup is doing

* Optimize python os import

* Address Review: Remove uses of os.path
2017-09-28 22:51:38 -04:00
Daniele Procida d24f7ca6b5 Added .admonition to the CSS (#462)
Now generic admonitions are styled too.
2017-09-14 18:23:46 -04:00
Campbell Barton 728d5da2e4 Use explicit UTF8 encoding (#452)
* Use explicit UTF8 encoding

Resolves #451

* Resolve encoding issue with Python3 (#1)

* Use open from Py3 in Py2
2017-08-06 23:03:12 -04:00
Aaron Carlisle 2f8946f3d3 Add missing pygments css link 2017-07-29 20:19:52 -04:00
Eric Holscher 3e386cdf1f Merge pull request #443 from halfninja/lang-attr
Reflect language in lang attribute.
2017-07-27 08:54:39 -07:00
Nick Howes 6bdf3adcc0 Convert underscores to dashes. 2017-07-23 08:37:06 +01:00
Nick Howes c6fe630542 Reflect language in lang attribute. 2017-07-21 22:37:03 +01:00
Eric Holscher b3225c5566 Merge pull request #425 from segevfiner/setuptools-entry-points
Added setuptools entry point for Sphinx
2017-06-26 15:53:37 -07:00
Segev Finer 31d410f2d4 Replace master with v0.2.5 in README.rst 2017-06-18 07:05:18 +03:00
Aaron Carlisle 1d1b2cd55d Merge branch 'master' into caption-margin 2017-06-18 00:04:49 -04:00
Aaron Carlisle c6d926e1cf Merge branch 'master' into setuptools-entry-points 2017-06-17 18:33:01 -04:00
Benjamin Bach 1dc21dbfd3 Add missing dependency in dev setup: sphinxcontrib-httpdomain (#431) 2017-06-17 18:05:41 -04:00
Benjamin Bach 93e6fe24bc Finalized #418 (#433)
Cleanup README.rst

* Refactor list items.
* Use autonumbering in lists to prevent errors.
* Indent code inside list items to make it belong to those items.
* Use inline-code style for filenames.
* Update link to a pull request with new repo path.
* Fix a few typos and punctuation.
* Use .. code:: bash for proper highlighting
* Use # for comments in bash
* Use ordered list for step-by-step instuctions.

* Make all code blocks 4 space indents
2017-06-17 14:42:04 -04:00
Segev Finer 1056aea4ab Added a link to the Sphinx documentation about setuptools entry points 2017-06-14 08:07:35 +03:00
Segev Finer f539c0e1f2 Added setuptools entry point for Sphinx
This allows using `sphinx_rtd_theme` as Sphinx `html_theme` directly.
2017-05-30 13:43:50 +03:00
Massimo Zaniboni 71b90d076d Fixed error in demo.rst (#421) 2017-05-21 13:01:01 -04:00
Anthony aedac3d526 Merge pull request #412 from rtfd/doc-theme-release
Add some basic docs around releasing the theme.
2017-04-18 11:12:20 -07:00
Eric Holscher 57a718370b Address review feedback 2017-04-18 09:58:24 -07:00
Aaron Carlisle 2bb8782c80 Set margin-bottom to 0 for captions in figures
The issue here is that figures have a margin of 24px and `p` tags also have a margin of 24px so figure caption get huge 48px margins on the bottom.
2017-04-18 00:21:12 -04:00
Eric Holscher 352057c08c Fix indent erro 2017-04-17 13:44:36 -07:00
Eric Holscher 4fff7fe5b9 Add some basic docs around releasing the theme.
This just covers the basic tasks that I know need to happen,
feel free to suggest other improvements.
2017-04-17 13:43:33 -07:00
Eric Holscher 4be9ff3fd1 Release 0.2.5b1 2017-04-17 13:36:22 -07:00
Aaron Carlisle d2a6253d9c Cleanup: Move images into static folder 2017-04-08 23:56:06 -04:00
Aaron Carlisle 9da9342796 Remove layout_old
This file was unused and serves no purpose
2017-04-08 18:23:52 -04:00
Aaron Carlisle 8f29534525 Revert Recent changes 2017-04-08 18:07:20 -04:00
Aaron Carlisle 9170fca5a2 Fix small typo 2017-04-08 15:59:34 -04:00
Aaron Carlisle 7329075b9d Readme: remove old developer docs saying to run grunt before a PR
This is hard when we have many PRs open and often get left with a bunch of merge conflicts.
2017-04-04 14:14:28 -04:00
Aaron Carlisle 1124c40137 Readme move canonical_url documentation 2017-04-04 14:11:59 -04:00
Aaron Carlisle dc9d3d732e Readme: remove outdated text about building on rtd 2017-04-04 13:59:26 -04:00
Aaron Carlisle e7e082ace8 Run grunt build 2017-03-31 21:20:11 -04:00
Aaron Carlisle 4b90748f1f Add recent changes to 2017-03-28 18:49:08 -04:00
Anthony c99e5d2e8d Merge pull request #394 from rtfd/fix-149
Fix #149 Fix padding for field list
2017-03-28 09:17:11 -07:00
Anthony cf73bd01d2 Merge pull request #391 from rtfd/latofont
Fix #256 include lato italic font
2017-03-28 09:09:17 -07:00
Aaron Carlisle fb986026b8 Update node packages 2017-03-23 00:07:01 -04:00
Aaron Carlisle ce7134e40b Run grunt build 2017-03-22 23:56:33 -04:00
Aaron Carlisle f41d88df1f Add font files via grunt 2017-03-22 23:09:44 -04:00
Anthony 505fbb5f7e Merge pull request #389 from rtfd/nav-buttons
Set the before & after width of the nav buttons to 100%
2017-03-22 16:58:33 -07:00
Anthony 6f45114058 Merge pull request #392 from rtfd/brightcaptions
Use lighter color for sidebar captions
2017-03-22 16:32:33 -07:00
Aaron Carlisle 09b5d695bb Add changes done in master to changelog
* Include fontawesome-webfont.woff2 in pip package
* Updated wyrm_ and Font Awesome
* Split multiple data types on different lines
* Italicize ``.versionmodified``
* Fix line number spacing to align with the code lines
* Hide Edit links on auto created pages
* Align ``.. centered::`` text to the center
* Increase contrast for footnotes
* Add language to the JS output variable
2017-03-22 11:02:16 -04:00
Aaron Carlisle 340ad42abd Add new font files 2017-03-21 18:07:48 -04:00
Aaron Carlisle e39e83d85e Merge remote-tracking branch 'refs/remotes/origin/master' into latofont 2017-03-21 18:03:51 -04:00
tobiasH 219d8773c5 Add language to the JS output variable (#400)
Makes the current language accessible as a JS variable.
Would be nice to have for the version & language switch I'm writing (to avoid the workaround of extracting it from the url).
2017-03-21 16:37:32 -04:00
Aaron Carlisle 6023e6200d Demodocs: Add caption for a code-block 2017-03-21 14:38:57 -04:00
Aaron 746536cf3d Give inline image a width of 1em 2017-03-16 17:43:54 -04:00
Aaron Carlisle 3deb16e441 Demodocs: Cleanup, text wrapping 2017-03-15 13:48:31 -04:00
Aaron Carlisle 4aaaff45d2 Demodocs: Fix compiling warnings 2017-03-15 13:45:26 -04:00
Aaron Carlisle 45bce91f46 Demodocs: make headline types the same 2017-03-15 13:37:23 -04:00
Aaron Carlisle c1e39adfb0 Demodocs: Simplify heading 2017-03-15 13:33:11 -04:00
Aaron Carlisle 31c9023c4f Demodocs: Use gloable section numbering 2017-03-15 13:29:04 -04:00
Aaron Carlisle a2c0f30d4e Demodocs: move text wraped around image to structure page 2017-03-15 13:23:21 -04:00
Aaron Carlisle 17b1a3c255 Demodocs: Update last reviewed 2017-03-15 13:16:52 -04:00
Aaron Carlisle cd38901fc2 Demodocs: increase toc depth 2017-03-15 13:16:06 -04:00
Aaron Carlisle c71e68df34 Demodocs: move the rest of the example from the index page 2017-03-15 13:13:46 -04:00
Aaron Carlisle 34a1f7e210 Demodocs: Delete "toc" page 2017-03-15 01:54:19 -04:00
Aaron Carlisle dd44dd63f8 Demodocs: move text from index to demo 2017-03-15 01:52:40 -04:00
Aaron Carlisle 3c18f35391 Demodocs: Structual edits 2017-03-15 01:49:45 -04:00
Aaron Carlisle f076409698 Demodocs: Move image to demo page 2017-03-15 01:44:18 -04:00
Aaron Carlisle 4b84896c03 Demodocs: Edit lists_tables structure 2017-03-15 01:41:10 -04:00
Aaron Carlisle e799486239 Demodocs: Fix compile warnings 2017-03-15 01:36:07 -04:00
Aaron Carlisle d893e8f5b2 Demodocs: edits to demo title levels 2017-03-15 01:33:08 -04:00
Aaron Carlisle 96959e9534 Demodocs: move list and tables to one file 2017-03-15 01:25:33 -04:00
Aaron Carlisle 99501fd317 Demodocs: Merge duplicate citations 2017-03-15 01:21:33 -04:00
Aaron Carlisle a830dcbcee Demodocs: Move content from index into sub pages 2017-03-15 01:18:44 -04:00
Aaron Carlisle ae72867219 Demodocs: Rename page 2017-03-15 01:15:45 -04:00
Aaron Carlisle fa3cf041f3 Demodocs: Edits to index 2017-03-15 01:13:19 -04:00
Aaron Carlisle 13933c5c6c Demodocs: Add new file 2017-03-15 01:08:42 -04:00
Aaron Carlisle 7f5a126437 Demodocs: Create new "Structural Elements" page 2017-03-15 01:06:51 -04:00
Aaron Carlisle 9c068cd6ff Demodocs: remove initial creation note 2017-03-15 00:56:36 -04:00
Aaron Carlisle 53162d0092 Demodocs: decrease headline level 2017-03-15 00:55:12 -04:00
Aaron Carlisle ce63b15f9f Demodocs: remove double list in Admonitions 2017-03-15 00:54:00 -04:00
Aaron Carlisle 8587226e8b Demodocs: add figwidth to an image 2017-03-15 00:48:43 -04:00
Aaron Carlisle 530368b415 Demodocs: move admonition with a table 2017-03-15 00:47:24 -04:00
Aaron Carlisle 7fea250782 Demodocs: simplify citation 2017-03-15 00:43:22 -04:00
Aaron Carlisle df2b25a81b Demodocs: Remove duplicate field list 2 2017-03-15 00:41:02 -04:00
Aaron Carlisle 695d96e47b Demodocs: Remove duplicate admonitions 2017-03-15 00:39:41 -04:00
Aaron Carlisle d9265d5aed Demodocs: cleanup, linelength 2017-03-15 00:37:13 -04:00
Aaron Carlisle 788b0cd172 Demodocs: remove double field list 2017-03-15 00:35:08 -04:00
Aaron Carlisle 84f914eac7 Demodocs: move version info into python module 2017-03-15 00:32:57 -04:00
Aaron Carlisle df71e5b460 Demodocs: add center aligned image caption 2017-03-15 00:29:33 -04:00
Aaron Carlisle 7fabadeb40 Fix own error 2017-03-15 00:27:29 -04:00
Aaron Carlisle 92aac927a3 Demodocs: fix image links 2017-03-15 00:26:45 -04:00
Aaron Carlisle 6054d1fc19 Demodocs: remove error handling section
We do not need this as we are focused on the theme and the markup
2017-03-15 00:20:26 -04:00
Aaron Carlisle f2dd739a18 Demodocs: fix compiling warning 2017-03-15 00:01:11 -04:00
Aaron Carlisle e296b0ffcf Demodocs: pep8 2017-03-14 23:52:32 -04:00
Aaron Carlisle fd2679358e Demodocs: fix empty python file 2017-03-14 23:48:47 -04:00
Aaron Carlisle 45243575d7 Run grunt build 2017-03-14 23:48:09 -04:00
Aaron f1549dbd94 Use text-medium instead of grey-light 2017-03-14 21:17:24 -04:00
Aaron Carlisle b400b1efd0 Fix #110 Low contrast text in footnotes strains legibility
While not a big imporvement this slighty darkens the text of footnotes.
It also helps that is a darker version of the text so it looks more consistent.
2017-03-14 21:09:33 -04:00
Aaron Carlisle 902d36da19 Align centered text to actually be centered 2017-03-14 12:31:38 -04:00
Aaron Carlisle 2448927b55 Fix padding for field lists 2017-03-13 23:04:48 -04:00
Aaron Carlisle 235d6dc7a4 Merge branch 'fix-149' of https://github.com/rtfd/sphinx_rtd_theme into fix-149 2017-03-13 22:36:18 -04:00
Eric Holscher 7e383bef69 Merge pull request #393 from rtfd/fix-252
Match change done in readthedocs fix #252
2017-03-13 19:10:44 -07:00
Aaron 8dd9211318 Match change done in readthedocs 2017-03-13 20:14:41 -04:00
Aaron Carlisle b2ddb25751 Use lighter color for sidebar captions 2017-03-13 19:57:04 -04:00
Aaron f24264cd76 Add 8px top padding 2017-03-12 15:37:31 -04:00
Aaron b89d1e3e2c Include lato font fix #256 2017-03-12 15:03:58 -04:00
Aaron Carlisle aedfa62f46 Run grunt build 2017-03-12 14:57:12 -04:00
Aaron c0538b4a31 Small fix for api version markup 2017-03-11 11:46:19 -05:00
Aaron 222c8f44ed Width 100% before & after 2017-03-10 18:54:45 -05:00
Anthony dcd1ad7dd6 Merge pull request #384 from rtfd/fix-90
Data display as a table
2017-03-10 15:27:52 -08:00
Sergey B Kirpichev dc3f4a722f Amend #344, correct spacing on line-numbering (#382)
Closes #381
2017-03-10 17:23:59 -05:00
Eric Holscher 5f4b7619d0 Merge pull request #388 from rtfd/version-info
Version info: italics
2017-03-10 14:01:33 -08:00
Aaron Carlisle 7b15320c60 Go back to just .versionmodified 2017-03-09 21:54:12 -05:00
Aaron 421b19a785 Use sub class 2017-03-09 21:35:53 -05:00
Aaron 2b6791201b Version info font to italics 2017-03-09 21:32:31 -05:00
Aaron d728bb5a60 Demodocs: fix broken image links 2017-03-09 21:20:15 -05:00
Aaron 35e5849d00 Demodocs: add normal literal 2017-03-09 20:59:27 -05:00
Aaron eb546c18e1 Demodocs: add centered directive 2017-03-09 20:10:42 -05:00
Aaron b12feeff5c Demodocs: add api version markup 2017-03-09 19:42:58 -05:00
Aaron Carlisle e2fa108664 Simpler fix 2017-03-09 16:52:04 -05:00
Aaron 5f2b7503db Data display as a table 2017-03-08 16:07:46 -05:00
Aaron 4f8f1cf425 Demodocs: Add data description 2017-03-08 14:43:23 -05:00
Aaron c7f5bf20ef Demodocs: add missing space 2017-03-08 14:32:56 -05:00
Aaron 0168de7d8f Demodocs: add data
Not sure this is the best place to put this. I am also not sure what it does.

See https://github.com/rtfd/sphinx_rtd_theme/issues/90
2017-03-08 14:27:25 -05:00
Aaron Carlisle 7326e731f3 Revert recent changes 2017-03-08 11:26:13 -05:00
Aaron ef17202b61 hide header link until hover 2017-03-08 11:11:39 -05:00
Aaron 3529ad9f5f Eqno: float right 2017-03-08 11:08:04 -05:00
Aaron Carlisle 77a7002d24 Run grunt build 2017-03-08 10:58:28 -05:00
Aaron Carlisle 080e748c66 Demodocs: add math label and equation link 2017-03-08 10:55:11 -05:00
Aaron Carlisle 8955083f1a Add a math label and equation link link 2017-03-08 10:53:00 -05:00
Aaron 9e2c93d2f5 line-block: set the left margin to 0px 2017-03-07 22:52:20 -05:00
Aaron Carlisle 78ed095265 Demodocs: use white svg logo 2017-03-07 14:56:19 -05:00
Aaron Carlisle 52db22823b Demodocs: add long column 2017-03-07 14:40:13 -05:00
Aaron Carlisle 87bf7211de Demodocs: cleanup indent 2017-03-07 14:23:20 -05:00
Aaron 1009aac83b Update bower.json with missed edits/updates over time (#377)
Updates the following:

- version
- homepage
- wyrm (devDependencies)
- font-awesome
2017-03-07 13:40:47 -05:00
Aaron Carlisle 609f5cf8fd Revert "Wrap captions text for figures in tables"
This was meant for my branch
This reverts commit eb68d098c7.
2017-03-07 12:49:29 -05:00
Aaron eb68d098c7 Wrap captions text for figures in tables 2017-03-07 12:46:58 -05:00
Aaron Carlisle febd2619af Demo docs: add wrapped image with a long caption 2017-03-07 09:42:26 -05:00
Aaron Carlisle 53208b89db Demo Docs: add html logo 2017-03-07 01:09:40 -05:00
Aaron Carlisle 5d35473fc3 Demodocs add link to genindex 2017-03-07 01:00:39 -05:00
Aaron Carlisle dae1d9a173 Demodocs: Add Glossary 2017-03-07 00:49:02 -05:00
Aaron Carlisle 9b3d65a4ce Demodocs: bump version to 0.2.4 2017-03-07 00:14:17 -05:00
Aaron Carlisle bc7fff2a45 Demo Docs: add kbd and menuselection 2017-03-07 00:06:55 -05:00
Aaron Carlisle 5c704b8108 Demo Docs: Add more things to lists 2017-03-06 23:50:56 -05:00
Aaron Carlisle 02436ca9b4 Demo Docs: Add problematic tables 2017-03-06 23:32:25 -05:00
Aaron Carlisle 8df9434a3e Add a caption to the literalinclude
This is added for testing cases like https://github.com/rtfd/sphinx_rtd_theme/issues/292
2017-03-06 22:52:51 -05:00
Aaron Carlisle 86bafcac74 Run grunt build 2017-03-06 20:10:57 -05:00
Aaron 42cabf15ae Fix broken font link (#371)
This fixes a bad file name giving a broken link to a font file.
2017-03-06 19:41:52 -05:00
Anthony 693deeef4c Merge pull request #372 from Minecrell/patch-1
Include fontawesome-webfont.woff2 in pip package
2017-03-06 15:52:08 -08:00
Anthony 96e8042212 Merge pull request #376 from rtfd/prepare-0.2.4
Pinning 0.2.4 release
2017-03-06 15:33:32 -08:00
Anthony Johnson 20dd4ebd81 Typo 2017-03-06 15:33:04 -08:00
Anthony Johnson 06da7a2d3c More identifiers 2017-03-06 15:26:37 -08:00
Anthony Johnson b96ec39e3d Pinning 0.2.4 release 2017-03-06 15:23:16 -08:00
Anthony 0dc421629b Merge pull request #375 from rtfd/fix-and-test-empty-toctree
Adds testing and hopefully a final fix for the empty toctree issue
2017-03-06 15:20:16 -08:00
Anthony Johnson 9d636a8850 Altern conditional check on builder name 2017-03-06 15:12:42 -08:00
Eric Holscher aa8477b7a7 Small change in README to trigger tests 2017-03-06 14:56:12 -08:00
Anthony Johnson 79c72ef53d Adds testing and hopefully a final fix for the empty toctree issue
This adds some more hacky fixes to our layout to avoid singlehtml builders.
Instead of trying to guess if this is working, I added testing!
2017-03-06 14:45:58 -08:00
Anthony 4dc19dc62a Merge pull request #373 from snide/fix-singlehtml
Fix problem triggered by unconditional toctree call and empty toctree
2017-03-06 10:24:12 -08:00
Anthony Johnson f71a918705 Bump -> 0.2.3 2017-03-06 10:10:29 -08:00
Anthony Johnson 0af470f7cf Fix problem triggered by unconditional toctree call and empty toctree
Refs rtfd/readthedocs.org#2398
2017-03-06 10:09:54 -08:00
Minecrell e1e317edb8 Include fontawesome-webfont.woff2 in pip package
fontawesome-webfont.woff2 was added in f22bfd2, but it was never added to the white list for the pip package. Without the woff2 file, modern browsers are required to fall back to the older woff format which has a slightly larger file size.
2017-03-05 19:50:44 +01:00
Eric Holscher 82484eb5b5 Merge branch 'canonical_url_support' of https://github.com/Nobatek/sphinx_rtd_theme into Nobatek-canonical_url_support 2017-03-04 19:13:32 -08:00
Eric Holscher 5b33b56747 Bump version to 0.2.2 2017-03-03 15:21:08 -08:00
Eric Holscher dc0cb5041d Revert "Display the toctree conditionally"
This reverts commit 398636c366.
2017-03-03 15:20:19 -08:00
Eric Holscher 636e27c37d Update files 2017-03-03 15:01:58 -08:00
Eric Holscher 8cf74da383 Update guilabel color 2017-03-03 15:01:37 -08:00
Jonathan Jacobs 3dda652901 Actually remove caps. 2017-03-03 15:01:32 -08:00
Jonathan Jacobs d4c89c43f5 Decrease border box, add margin and remove caps, based on review commentary. 2017-03-03 15:01:32 -08:00
Jonathan Jacobs 101a2970f2 Add a styling for :guilabel: inline markup. 2017-03-03 15:01:18 -08:00
Anthony Johnson a8b74fff1c Release for 0.2.1 2017-03-03 12:02:11 -08:00
Anthony 15f8d32295 Merge pull request #367 from snide/fix-singlehtml-missing-doctree
Display the toctree conditionally
2017-03-03 11:59:23 -08:00
Anthony Johnson 398636c366 Display the toctree conditionally
The `singlehtml` builder for sphinx doesn't produce a toctree, and was throwing
an exception on these builds. This makes use of the `display_toc` context
variable, used back to at least `sphinx==1.1`.
2017-03-03 11:38:10 -08:00
Anthony 20747b6551 Merge pull request #365 from snide/badge-image-fix
Remove forcing of image size on badge.
2017-03-02 15:31:05 -08:00
Eric Holscher 36f106ae79 Update minified CSS 2017-03-02 13:57:12 -08:00
Eric Holscher ecab5841c3 Remove forcing of image size on badge.
This is a really weird thing to do in our badge CSS.
It makes badges show up 100% width on sites that use our badge,
which seems like a broken thing.
2017-03-02 13:55:06 -08:00
Eric Holscher 1541a5fd73 Clean up changelog 2017-03-02 13:46:00 -08:00
Eric Holscher a25e7e1de7 Merge pull request #357 from jorgesumle/master
Add rel and rel HTML attributes to the footer links which point to th…
2017-03-02 13:44:42 -08:00
Eric Holscher 7a5b3f86d6 Bump version 2017-03-01 11:49:54 -08:00
Eric Holscher 9be7039227 Release beta of this version 2017-03-01 11:49:54 -08:00
Jorge Maldonado Ventura 36c89ff1c3 Corrections to last commit 2017-02-23 10:09:36 +01:00
Anthony Johnson 6eda7be38e Merge branch '290-sidebar-context-sphinxcontrib.httpdomain-fix' 2017-02-21 16:31:54 -08:00
Mathieu Agopian ce8dc13298 Grunt build 2017-02-21 16:30:54 -08:00
Mathieu Agopian afaf0dc9bd Use the closest section when clicking on a headerlink that isn't in the sidebar 2017-02-21 16:26:26 -08:00
Anthony 92ac72952f Merge pull request #355 from trynthink/fix-download-text
Fix :download: role text formatting
2017-02-21 16:19:35 -08:00
= 2f60d2c29d Add rel and rel HTML attributes to the footer links which point to the previous and next pages. 2017-01-30 23:58:50 +01:00
Chioke Harris 69e497a456 Fix download role text format
Fix :download: role text formatting so that the link text after the first word is not bolded and the first word has the same font smoothing settings as the rest of the standard theme text. Close #303.
2017-01-26 09:46:22 -05:00
Eric Holscher eef98b316b Merge pull request #351 from MrSenko/comment_block
Add comments block which can be overriden
2017-01-04 17:42:26 -08:00
Mr. Senko f726a80652 Add comments block which canbe overriden 2016-12-28 15:28:59 +02:00
Eric Holscher abfa98539a Merge pull request #346 from mikkeloscar/sourcelink
Add missing SOURCELINK_SUFFIX
2016-12-09 13:35:41 -08:00
Mikkel Oscar Lyderik Larsen a5e0e304d3 Add missing SOURCELINK_SUFFIX
Adds DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX which is expected by the
searchtools.js

Related sphinx commit:
https://github.com/sphinx-doc/sphinx/commit/71dd8bfbf94417ad55b2444e1dbd219db266f335
2016-12-08 23:33:23 +01:00
Anthony b3ee01006b Merge pull request #345 from denisvm/gitlab
Add 'Edit on GitLab' support
2016-12-05 12:06:58 -08:00
Denis Volpato Martins 29ac8e86b8 Update GitLab info on README 2016-12-05 12:41:55 -02:00
Denis Volpato Martins f22bfd278e Add 'Edit on GitLab' support 2016-12-05 12:35:53 -02:00
Eric Holscher dafd07bff1 Merge pull request #344 from skirpichev/fix-pre
Fix spacing in pre
2016-11-30 16:06:43 -08:00
Eric Holscher 61eb48bc75 Merge pull request #335 from Carreau/cast-int
Cast maxdepth to an int.
2016-11-30 16:06:09 -08:00
Eric Holscher e43226965e Merge pull request #343 from mlutfy/issue260-gettext
Add gettext functions to all messages (2)
2016-11-30 09:03:19 -08:00
Sergey B Kirpichev 7f307a840c Fix spacing in pre
Closes #329
2016-11-28 13:37:28 +03:00
Mathieu Lutfy 07fdc8f5cd versions.html: do not translate 'Read the Docs' (branding). 2016-11-25 11:40:20 -05:00
Mingun c2197a5f7d Ready for translation: add gettext functions to all messages, which has no translation tags. 2016-11-25 11:37:15 -05:00
Matthias Bussonnier 56e4e4c4dd Cast maxdepth to an int.
closes #334
2016-10-17 12:21:46 -07:00
Eric Holscher 454aa28652 Merge pull request #331 from Carreau/next-previous-top
Add Next/Previous next to top of each page.
2016-10-12 10:58:27 -07:00
Matthias Bussonnier 01707b94f5 Make location of buttons configurable
Add the `prev_next_buttons_location` variable which understand `top`,
`bottom`, `both`.Any other value will not display the next and previous
buttons.

Not setting the value leave it to `bottom` by default.
2016-10-09 10:18:49 -07:00
Eric Holscher f6b4f8268d Merge pull request #327 from tltx/patch-1
Configure package as py2, py3 universal wheel
2016-10-07 10:14:52 -07:00
Matthias Bussonnier 42e4fc0bbb Add Next/Previous next to top of each page.
This makes it much easier to navigate documentation, instead of having
to scroll to the bottom of the page, or use the Toctree on the side
which is hard to use on mobile; or if you are unsure what you are
looking for.
2016-09-30 16:22:05 -07:00
Tore Lundqvist 6986e011c6 Configure package as py2, py3 universal wheel 2016-09-26 20:26:33 +02:00
Eric Holscher 26c82648c4 Merge pull request #311 from akien-mga/pr-readme-html_theme_options
Document how to configure via html_theme_options
2016-07-26 18:20:43 -07:00
Rémi Verschelde edb9da7bd3 Document how to configure via html_theme_options 2016-07-20 23:01:54 +02:00
Eric Holscher f2cfc5b838 Merge pull request #309 from snide/conf-nav-depth
Add option for navigation depth
2016-07-20 12:45:16 -07:00
Eric Holscher 9d4cbf2cb8 Merge pull request #310 from snide/mobile-nav-block
Add template block around mobile_nav
2016-07-20 12:44:09 -07:00
Anthony Johnson cfb4a3ec96 Add template block around mobile_nav 2016-07-19 16:32:47 -07:00
Anthony Johnson 923082974c Add option for navigation depth 2016-07-19 14:58:21 -07:00
Eric Holscher 42d71c30c3 Merge pull request #307 from scop/optimize-images
Optimize images
2016-07-18 12:11:43 -07:00
Eric Holscher 690194e413 Merge pull request #308 from snide/breadcrumb-templating
Add template blocks around breadcrumbs
2016-07-12 12:40:16 -07:00
Anthony Johnson 851596f6e8 Add template blocks around breadcrumbs 2016-07-12 12:30:54 -07:00
Ville Skyttä 220b52ccfa Run *.png through zopflipng -m
Before: 252965 bytes
After:  226202 bytes
2016-07-07 15:56:53 +03:00
Ville Skyttä 502596d2c0 Run *.jpg through jpegoptim -s
Before: 9498 bytes
After:  6614 bytes
2016-07-07 15:53:24 +03:00
Anthony e9481bfea5 Merge pull request #302 from snide/fix-meta
Fix how we check for meta and make sure it isn't None
2016-06-21 16:37:06 -07:00
Eric Holscher 005ab29550 Fix how we check for meta and make sure it isn't None 2016-06-21 10:39:23 -07:00
Anthony Johnson 9c5cee8529 Bump version number 2016-06-14 16:28:32 -07:00
Anthony Johnson 4af13ee0ac Add release notes 2016-06-14 16:21:27 -07:00
Eric Holscher 296e1089e6 Merge branch 'define-edit-link-in-meta' 2016-06-03 16:15:23 -07:00
Eric Holscher 288a4519cb Add a bit of docs 2016-06-03 16:15:08 -07:00
Anthony 811d671d2f Merge pull request #300 from snide/define-edit-link-in-meta
Allow users to override "Edit" links to GH/BB.
2016-06-03 16:12:58 -07:00
Eric Holscher 09abc5f15d Fix BB icon 2016-06-03 16:11:56 -07:00
Eric Holscher 789c5a0e73 Allow users to override "Edit" links to GH/BB.
This allows you to set a :github_url: or :bitbucket_url:
in your file metadata and have it override the Edit URL.
2016-06-03 16:09:49 -07:00
Jérôme Lafréchoux 543b4d8372 Add support for canonical URLs 2016-03-25 16:47:38 +01:00
Eric Holscher eeff5645dc Fix block name. 2016-01-11 16:51:26 -08:00
Eric Holscher fdf474fc8b Merge pull request #268 from leoshaw/master
Add a body_begin block at the start of <body>
2016-01-11 16:50:45 -08:00
Eric Holscher c6455d278b Merge pull request #275 from mitya57/master
Drop dependency on Sphinx
2016-01-11 16:48:25 -08:00
Eric Holscher 47fff524a3 Merge pull request #255 from zhanghongyi/fix-bar
Make bar icon vertically centered in the nav menu in mobile view
2016-01-11 16:47:32 -08:00
Dmitry Shachnev 9e2b17147d Drop dependency on Sphinx
Fixes #189.
2016-01-10 16:40:56 +03:00
Leo Shaw 3a5fd41b31 Add a body_begin block at the start of <body>
This makes it easy to add a cookie banner or similar at the top of the
page, particularly when JS is disabled and you can't insert the banner
dynamically.
2015-11-27 11:49:15 +00:00
Hongyi Zhang 022d936dd9 add padding to make bar icon vertically centered in the nav menu
Signed-off-by: Hongyi Zhang <hongyi73.zhang@gmail.com>
2015-10-10 15:13:52 -07:00
Eric Holscher 012d42db6a Merge pull request #253 from zhanghongyi/fix-indentation
fix indentation level
2015-10-09 17:10:13 -07:00
Hongyi Zhang 360c761960 fix indentation level
Signed-off-by: Hongyi Zhang <hongyi73.zhang@gmail.com>
2015-10-02 12:28:43 -07:00
Eric Holscher 8c880a64fa Merge pull request #251 from snide/check-running
Add check for an already running nav
2015-09-23 13:50:55 -07:00
Anthony Johnson d01cb61473 Add check for an already running nav
Fixes #250
2015-09-23 10:55:10 -07:00
Anthony Johnson 84b5075f5b Merge branch 'rc-0.1.9' 2015-09-15 14:20:40 -07:00
Anthony Johnson 1234f126d8 Version bump and changelog edits 2015-09-15 14:18:11 -07:00
Anthony Johnson 173cdfc140 Increase vertical padding on code elements slightly
Fixes #242
2015-09-15 13:50:00 -07:00
Anthony 0a1b9e885c Merge pull request #243 from snide/js-refactor
Make theme into a consumable bundle for RTD
2015-09-15 13:34:11 -07:00
Anthony Johnson 7cd2007b7b Add font-awesome explicitly 2015-09-10 16:21:10 -07:00
Anthony Johnson a02faa6753 Fonts are not only a dev dependency 2015-09-10 15:51:10 -07:00
Anthony Johnson 300f9f01ec Source fonts from bower packages as well
This will be used on RTD to source the same font files from bower packages
2015-09-10 15:45:47 -07:00
Anthony 36b1648b71 Merge pull request #241 from leplatrem/patch-1
Add block to add extra content to footer
2015-09-10 12:39:02 -07:00
Mathieu Leplatre b2b24228f3 Add block to add extra content to footer
For example, in order to add Disqus comments.
2015-09-10 11:05:11 +02:00
Anthony Johnson f0863fa0eb Refactor js to exportable module 2015-09-09 00:17:10 -07:00
Anthony a65c3b5ebe Merge pull request #239 from benmwebb/patch-1
Fix a handful of minor typos.
2015-09-08 22:03:40 -07:00
Anthony 2992ca2119 Merge pull request #215 from agjohnson/fix-nav-scrollbar
Resolve scrollbar visibility on navbar on long content
2015-09-08 20:42:23 -07:00
Anthony Johnson 60eb0af7fb Resolve scrollbar visibility on navbar on long content
This resolves #200, where a scrollbar was sometimes visible on the navbar. This
unfortunately wasn't addressable with just CSS, as outlined in #206. Because we
need the element to be scrollable, we can't set `overflow: hidden` on the nav
element.

This fixes this issue by:

 * Adding a `wy-side-scroll` element over the fixed position nav element and
   under the menu item elements
 * `wy-side-scroll` is set to 320px width, while the fixed position nav elements
   and menu item elements are 300px, clipping the scrollbar with `overflow-x:
   hidden` on the fixed position element
 * Javascript is set to scroll the new scroll element instead of the parent
   fixed position element

This was tested to be working in both cases on a variety of platforms: Linux FF,
Chrome, Windows IE, OSX Chrome and Safari, iPhone 5.1, and Android 4.2.
2015-09-08 20:35:34 -07:00
Ben Webb a257f6dac5 Fix a handful of minor typos. 2015-09-03 15:26:46 -07:00
Eric Holscher 66d865d9c4 Merge pull request #233 from snide/add-page-suffix-support
This fixes the "Edit on GH" links on recommonmark Sphinx docs
2015-08-18 16:44:48 -07:00
Eric Holscher dcde79291a This fixes the "Edit on GH" links on recommonmark Sphinx docs 2015-08-12 17:53:10 -07:00
Eric Holscher e8b2b72110 Merge pull request #226 from IKavanagh/master
Separated some sass variables
2015-07-30 11:31:30 -07:00
Ian Kavanagh 3de4352b2f Separated some sass variables 2015-07-25 19:01:18 +01:00
Eric Holscher d0ab15b6a8 Merge pull request #223 from snide/fix-figure-caption
Fix figure caption styling, fixes #197
2015-07-21 21:52:32 -07:00
Anthony Johnson 436c90aea4 Fix figure caption styling, fixes #197 2015-07-21 19:12:21 -07:00
Eric Holscher f1208215d7 Merge pull request #220 from snide/fix-safari-overscroll
Fix Safari over-scroll bug, fixes #218
2015-07-20 11:22:33 -07:00
Eric Holscher aeeecc905c Merge pull request #208 from snide/add-commit
Add commit to the footer is it exists
2015-07-20 11:20:30 -07:00
Eric Holscher 4fc47538d1 Update gen'd files 2015-07-20 11:19:13 -07:00
Anthony Johnson cfb399e458 Clean up display of revision and build
This will require a patch on RTD side, to pass in `build_id` and `build_url`
in the template context.
2015-07-20 11:18:49 -07:00
Eric Holscher 8779eb380b Add commit to the footer is it exists 2015-07-20 11:18:37 -07:00
Eric Holscher aacc59f07a Merge remote-tracking branch 'agjohnson/fix-code-color'
Conflicts:
	sphinx_rtd_theme/static/css/theme.css
	sphinx_rtd_theme/static/css/theme.css.map
2015-07-20 11:16:02 -07:00
Eric Holscher f772a1ff34 Merge remote-tracking branch 'agjohnson/fix-citation-code'
Conflicts:
	sphinx_rtd_theme/static/css/theme.css
	sphinx_rtd_theme/static/css/theme.css.map
2015-07-20 11:14:51 -07:00
Eric Holscher 27c0270ebe Merge pull request #216 from agjohnson/fix-toctree
Fix issue with toctree :titlesonly: and nav menu
2015-07-20 11:13:19 -07:00
Eric Holscher 74b146ed62 Merge pull request #212 from snide/add-version
Include version in the page
2015-07-20 11:13:02 -07:00
Anthony Johnson 5e7d604290 Add configurable version display to nav header
This adds a subtle version display to the nav header. It will pull this
information from conf.py `version` if it exists, or if on RTD, `current_version`
from the conf additional context. If neither exists, or the `display_version`
option is false, the block will not display.
2015-07-17 16:41:52 -07:00
Anthony Johnson 9f908fff9c Fix Safari over-scroll bug, fixes #218
Protect against negative scroll values or scroll values past the end of the
document. Stop scrolling if this is the case.
2015-07-17 15:48:27 -07:00
Anthony Johnson 591c2283a8 Make code block color match Wyrm code block color
This fixes #203. As of Sphinx 1.3, there are some code blocks that shouldn't
have this styling: namely breadcrumb code blocks and xref code blocks. This adds
additional rules for those as well.
2015-07-17 14:16:57 -07:00
Anthony Johnson 2cd2729188 Fix citation code color, fixes #204 2015-07-17 10:30:53 -07:00
Anthony Johnson 5392b7bdbd Fix issue with toctree :titlesonly: and nav menu
This fixes #196 by filtering nav ul elements that have empty ul siblings
2015-07-17 00:18:02 -07:00
Eric Holscher 6277c21110 Merge pull request #210 from snide/collapse-nav
Add theme option for collapsing the nav.
2015-06-29 12:33:08 -07:00
Eric Holscher 5e40211ac2 Fix default 2015-06-21 21:58:28 -04:00
Eric Holscher ae6c09b352 Add theme option for collapsing the nav.
This defaults to on,
because many use cases don't have large navs and want to see them all.
However,
it can be a large speedup for large docsets
2015-06-21 21:57:01 -04:00
Eric Holscher 9779e08157 Merge pull request #195 from bport/patch-2
Fix modernizr url
2015-06-01 16:09:19 -07:00
Eric Holscher a369939bb3 Merge pull request #202 from xuhdev/structured-data
Add microdata: tag the main content of a page as an article
2015-06-01 16:09:04 -07:00
Hong Xu af89f48341 Add microdata: tag the main content of a page as an article 2015-05-29 23:06:15 -07:00
Benjamin Port dc0a2a1e11 Fix modernizr url
If we are in a subdirectory it's not working anymore because the path of modernizr is all time _static/...
2015-05-05 14:52:06 +02:00
120 changed files with 5998 additions and 2677 deletions

No files matched your search

+16
View File
@@ -0,0 +1,16 @@
# Document global line endings settings
# https://help.github.com/articles/dealing-with-line-endings/
* text eol=lf
*.bat text eol=crlf
# Denote all files that are truly binary and should not be modified.
*.ai binary
*.jpg binary
*.otf binary
*.png binary
*.eot binary
*.ttf binary
*.whl binary
*.woff binary
*.woff2 binary
+5
View File
@@ -0,0 +1,5 @@
# Code of Conduct
A copy of our code of conduct can be found on Read the Docs as seen below.
http://docs.readthedocs.io/en/latest/code-of-conduct.html
+26
View File
@@ -0,0 +1,26 @@
### Problem
Give details on your issue.
### Reproducible Project
Please give a link to a public reproducible project or provide an example of the Restructured Text that gives an issue.
```rst
Place RST code here (if any).
```
#### Error Logs/Results
Place any images or error logs that might be able to help solve the issue here.
#### Expected Results
Please describe how this should work properly.
### Environment Info
- Python Version:
- Sphinx Version:
- RTD Theme Version:
+6 -1
View File
@@ -6,8 +6,13 @@
.coverage
*.DS_Store
*.sass-cache
*.map
.ropeproject/
.ruby-version
dist/
bower_components/
node_modules/
node_modules
npm-debug.log
package-lock.json
sphinx_rtd_theme/static/fonts/Lato/
sphinx_rtd_theme/static/fonts/RobotoSlab/
+5
View File
@@ -0,0 +1,5 @@
build:
image: latest
python:
version: 3.6
requirements_file: docs/requirements.txt
+18
View File
@@ -0,0 +1,18 @@
language: python
python:
- 2.7
- 3.4
- 3.5
- 3.6
matrix:
include:
- python: 2.7
env: TOXENV=docs
install:
- pip install tox-travis
script:
- tox
branches:
only:
- master
+1 -2
View File
@@ -1,5 +1,4 @@
sphinx_rtd_theme/static/fonts/RobotoSlab-Bold.ttf
sphinx_rtd_theme/static/fonts/RobotoSlab-Regular.tt/
/fonts/RobotoSlab/*
Apache License
-4
View File
@@ -1,4 +0,0 @@
# A sample Gemfile
source "https://rubygems.org"
gem "compass"
-16
View File
@@ -1,16 +0,0 @@
GEM
remote: https://rubygems.org/
specs:
chunky_png (1.2.9)
compass (0.12.2)
chunky_png (~> 1.2)
fssm (>= 0.2.7)
sass (~> 3.1)
fssm (0.2.10)
sass (3.2.12)
PLATFORMS
ruby
DEPENDENCIES
compass
+97 -13
View File
@@ -4,6 +4,9 @@ module.exports = function(grunt) {
require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
grunt.initConfig({
// Read package.json
pkg: grunt.file.readJSON("package.json"),
open : {
dev: {
path: 'http://localhost:1919'
@@ -14,7 +17,7 @@ module.exports = function(grunt) {
server: {
options: {
port: 1919,
base: 'demo_docs/build',
base: 'docs/build',
livereload: true
}
}
@@ -22,8 +25,27 @@ module.exports = function(grunt) {
copy: {
fonts: {
files: [
// includes files within path
{expand: true, flatten: true, src: ['bower_components/font-awesome/fonts/*'], dest: 'sphinx_rtd_theme/static/fonts/', filter: 'isFile'}
{
expand: true,
flatten: true,
src: ['bower_components/font-awesome/fonts/*'],
dest: 'sphinx_rtd_theme/static/fonts/',
filter: 'isFile'
},
{
expand: true,
flatten: true,
src: ['fonts/Lato/*'],
dest: 'sphinx_rtd_theme/static/fonts/Lato',
filter: 'isFile'
},
{
expand: true,
flatten: true,
src: ['fonts/RobotoSlab/*'],
dest: 'sphinx_rtd_theme/static/fonts/RobotoSlab/',
filter: 'isFile'
}
]
}
},
@@ -45,6 +67,7 @@ module.exports = function(grunt) {
build: {
options: {
style: 'compressed',
sourcemap: 'none',
loadPath: ['bower_components/bourbon/dist', 'bower_components/neat/app/assets/stylesheets', 'bower_components/font-awesome/scss', 'bower_components/wyrm/sass']
},
files: [{
@@ -57,17 +80,74 @@ module.exports = function(grunt) {
}
},
browserify: {
dev: {
options: {
external: ['jquery'],
alias: {
'sphinx-rtd-theme': './js/theme.js_t'
}
},
src: ['js/*.js_t'],
dest: 'sphinx_rtd_theme/static/js/theme.js_t'
},
build: {
options: {
external: ['jquery'],
alias: {
'sphinx-rtd-theme': './js/theme.js_t'
}
},
src: ['js/*.js_t'],
dest: 'sphinx_rtd_theme/static/js/theme.js_t'
}
},
uglify: {
dist: {
options: {
sourceMap: false,
mangle: {
reserved: ['jQuery'] // Leave 'jQuery' identifier unchanged
},
ie8: true // compliance with IE 6-8 quirks
},
files: [{
expand: true,
src: ['sphinx_rtd_theme/static/js/*.js_t', '!sphinx_rtd_theme/static/js/*.min.js_t'],
dest: 'sphinx_rtd_theme/static/js/',
rename: function (dst, src) {
// Use unminified file name for minified file
return src;
}
}]
}
},
usebanner: {
dist: {
options: {
position: 'top',
banner: '/* <%= pkg.name %> version <%= pkg.version %> | MIT license */\n' +
'/* Built <%= grunt.template.today("yyyymmdd HH:mm") %> */',
linebreak: true
},
files: {
src: [ 'sphinx_rtd_theme/static/js/theme.js_t', 'sphinx_rtd_theme/static/css/theme.css' ]
}
}
},
exec: {
bower_update: {
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: {
@@ -78,12 +158,17 @@ 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']
},
/* live-reload the demo_docs if sphinx re-builds */
/* JavaScript */
browserify: {
files: ['js/*.js_t','js/*.js'],
tasks: ['browserify:dev']
},
/* live-reload the docs if sphinx re-builds */
livereload: {
files: ['demo_docs/build/**/*'],
files: ['docs/build/**/*'],
options: { livereload: true }
}
}
@@ -97,9 +182,8 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-contrib-clean');
grunt.loadNpmTasks('grunt-contrib-copy');
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','exec:build_sphinx','connect','open','watch']);
grunt.registerTask('build', ['exec:bower_update','clean:build','sass:build','exec:build_sphinx']);
grunt.registerTask('default', ['exec:bower_update','clean','copy:fonts','sass:dev','browserify:dev','usebanner','exec:build_sphinx','connect','open','watch']);
grunt.registerTask('build', ['exec:bower_update','clean','copy:fonts','sass:build','browserify:build','uglify','usebanner','exec:build_sphinx']);
}
+1 -1
View File
@@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2013 Dave Snider
Copyright (c) 2013-2018 Dave Snider, Read the Docs, Inc. & contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
+3
View File
@@ -8,3 +8,6 @@ recursive-include sphinx_rtd_theme *.js
recursive-include sphinx_rtd_theme *.svg
recursive-include sphinx_rtd_theme *.ttf
recursive-include sphinx_rtd_theme *.woff
recursive-include sphinx_rtd_theme *.woff2
recursive-include tests *.py
recursive-include tests *.rst
+96 -104
View File
@@ -1,104 +1,96 @@
sphinx_rtd_theme/static/fonts/Inconsolata-Bold.ttf
sphinx_rtd_theme/static/fonts/Lato-Bold.ttf
sphinx_rtd_theme/static/fonts/Inconsolata.ttf
sphinx_rtd_theme/static/fonts/Lato-Regular.ttf
Copyright (c) <dates>, <Copyright Holder> (<URL|email>),
with Reserved Font Name <Reserved Font Name>.
Copyright (c) <dates>, <additional Copyright Holder> (<URL|email>),
with Reserved Font Name <additional Reserved Font Name>.
Copyright (c) <dates>, <additional Copyright Holder> (<URL|email>).
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL
-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------
PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.
The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.
"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).
"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).
"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.
"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.
PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:
1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.
2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.
3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.
5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.
TERMINATION
This license becomes null and void if any of the above conditions are
not met.
DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
sphinx_rtd_theme/static/fonts/Lato/*
Copyright (c) 2010-2015, Łukasz Dziedzic (dziedzic@typoland.com),
with Reserved Font Name Lato.
This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL
-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------
PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.
The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.
DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.
"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).
"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).
"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.
"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.
PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:
1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.
2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.
3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.
5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.
TERMINATION
This license becomes null and void if any of the above conditions are
not met.
DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
+42 -179
View File
@@ -1,191 +1,54 @@
.. _readthedocs.org: http://www.readthedocs.org
.. _bower: http://www.bower.io
.. _sphinx: http://www.sphinx-doc.org
.. _compass: http://www.compass-style.org
.. _sass: http://www.sass-lang.com
.. _wyrm: http://www.github.com/snide/wyrm/
.. _grunt: http://www.gruntjs.com
.. _node: http://www.nodejs.com
.. _demo: http://docs.readthedocs.org
.. _hidden: http://sphinx-doc.org/markup/toctree.html
**************************
Read the Docs Sphinx Theme
**************************
.. contents::
.. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg
:target: https://pypi.python.org/pypi/sphinx_rtd_theme
:alt: Pypi Version
.. image:: https://travis-ci.org/rtfd/sphinx_rtd_theme.svg?branch=master
:target: https://travis-ci.org/rtfd/sphinx_rtd_theme
:alt: Build Status
.. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg
:target: https://pypi.python.org/pypi/sphinx_rtd_theme/
:alt: License
.. image:: https://readthedocs.org/projects/sphinx-rtd-theme/badge/?version=latest
:target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
View a working demo_ over on readthedocs.org_.
The ``sphinx_rtd_theme`` is a sphinx_ theme designed to look modern and be mobile-friendly.
This theme is primarily focused to be used on readthedocs.org_ but can work with your
own sphinx projects. To read more and see a working demo_ head over to readthedocs.org_.
This is a mobile-friendly sphinx_ theme I made for readthedocs.org_. It's
currently in development there and includes some rtd variable checks that can be ignored
if you're just trying to use it on your project outside of that site.
.. _sphinx: http://www.sphinx-doc.org
.. _readthedocs.org: http://www.readthedocs.org
.. _demo: https://sphinx-rtd-theme.readthedocs.io/en/latest/
**This repo also exists as a submodule within the readthedocs itself**, so please make your edits to
the SASS files here, rather than the .css files on RTD.
.. image:: screen_mobile.png
:width: 100%
Installing
==========
Installation
The theme is distributed on PyPI_ and can be installed with pip::
pip install sphinx_rtd_theme
For more information read the full installing docs
`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html>`__.
.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
Configuration
=============
The ``sphinx_rtd_theme`` is highly customizable on both the page level and on a global level.
To see all the possible configuration options read the configuring docs
`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html>`__.
Contributing
============
Via package
-----------
Download the package or add it to your ``requirements.txt`` file:
.. code:: bash
$ pip install sphinx_rtd_theme
In your ``conf.py`` file:
.. code:: python
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
Via git or download
-------------------
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:
.. code:: python
html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]
Changelog
=========
v0.1.8
------
* Start keeping changelog :)
* Support for third and fourth level headers in the sidebar
* Add support for Sphinx 1.3
* Add sidebar headers for :caption: in Sphinx toctree
* Clean up sidebar scrolling behavior so it never scrolls out of view
How the Table of Contents builds
================================
Currently the left menu will build based upon any ``toctree(s)`` defined in your index.rst file.
It outputs 2 levels of depth, which should give your visitors a high level of access to your
docs. If no toctrees are set the theme reverts to sphinx's usual local toctree.
It's important to note that if you don't follow the same styling for your rST headers across
your documents, the toctree will misbuild, and the resulting menu might not show the correct
depth when it renders.
Also note that the table of contents is set with ``includehidden=true``. This allows you
to set a hidden toc in your index file with the hidden_ property that will allow you
to build a toc without it rendering in your index.
By default, the navigation will "stick" to the screen as you scroll. However if your toc
is vertically too large, it revert to static positioning. To disable the sticky nav
alltogether change the setting in ``conf.py``.
Contributing or modifying the theme
===================================
The sphinx_rtd_theme is primarily a sass_ project that requires a few other sass libraries. I'm
using bower_ to manage these dependencies and sass_ to build the css. The good news is
I have a very nice set of grunt_ operations that will not only load these dependecies, but watch
for changes, rebuild the sphinx demo docs and build a distributable version of the theme.
The bad news is this means you'll need to set up your environment similar to that
of a front-end developer (vs. that of a python developer). That means installing node and ruby.
Set up your environment
-----------------------
1. Install sphinx_ into a virtual environment.
.. code::
pip install sphinx
2. Install sass
.. code::
gem install sass
2. Install node, bower and grunt.
.. code::
// Install node
brew install node
// Install bower and grunt
npm install -g bower grunt-cli
// Now that everything is installed, let's install the theme dependecies.
npm install
Now that our environment is set up, make sure you're in your virtual environment, go to
this repository in your terminal and run grunt:
.. code::
grunt
This default task will do the following **very cool things that make it worth the trouble**.
1. It'll install and update any bower dependencies.
2. It'll run sphinx and build new docs.
3. It'll watch for changes to the sass files and build css from the changes.
4. It'll rebuild the sphinx docs anytime it notices a change to .rst, .html, .js
or .css files.
Before you create an issue
--------------------------
I don't have a lot of time to maintain this project due to other responsibilities.
I know there are a lot of Python engineers out there that can't code sass / css and
are unable to submit pull requests. That said, submitting random style bugs without
at least providing sample documentation that replicates your problem is a good
way for me to ignore your request. RST unfortunately can spit out a lot of things
in a lot of ways. I don't have time to research your problem for you, but I do
have time to fix the actual styling issue if you can replicate the problem for me.
Before you send a Pull Request
------------------------------
When you're done with your edits, you can run ``grunt build`` to clean out the old
files and rebuild a new distribution, compressing the css and cleaning out
extraneous files. Please do this before you send in a PR.
Using this theme locally, then building on Read the Docs?
==========================================================
Currently if you import sphinx_rtd_theme in your local sphinx build, then pass
that same config to Read the Docs, it will fail, since RTD gets confused. If
you want to run this theme locally and then also have it build on RTD, then
you can add something like this to your config. Thanks to Daniel Oaks for this.
.. code:: python
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# otherwise, readthedocs.org uses their theme by default, so no need to specify it
TODO
====
* Separate some sass variables at the theme level so you can overwrite some basic colors.
If you would like to help improve the theme or have more control
over the theme in case of a fork please read our contributing guide
`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html>`__.
+11 -7
View File
@@ -1,18 +1,17 @@
{
"name": "sphinx-rtd-theme",
"version": "0.1.7",
"homepage": "https://github.com/snide/wyrm",
"version": "0.4.3",
"homepage": "https://github.com/rtfd/sphinx_rtd_theme",
"authors": [
"Dave Snider <dave.snider@gmail.com>"
"Dave Snider, Read the Docs, Inc. & contributors <dev@readthedocs.org>"
],
"description": "Sphinx theme for readthedocs.org.",
"license": "MIT",
"main": [
"dist/**"
"js/theme.js"
],
"ignore": [
"docs",
"demo_docs",
".gitignore",
".DS_Store",
".sass-cache*",
@@ -27,7 +26,12 @@
"src"
],
"devDependencies": {
"wyrm": "~0.0.x"
"wyrm": "~1.0.x"
},
"dependencies": {
"font-awesome": "~4.7"
},
"resolutions": {
"font-awesome": "~4.7"
}
}
-153
View File
@@ -1,153 +0,0 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SphinxRTDthemedemo.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SphinxRTDthemedemo.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/SphinxRTDthemedemo"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SphinxRTDthemedemo"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
-7
View File
@@ -1,7 +0,0 @@
:mod:`test_py_module`
=====================
.. automodule:: test_py_module.test
:members:
:private-members:
:special-members:
-255
View File
@@ -1,255 +0,0 @@
# -*- coding: utf-8 -*-
#
# Sphinx RTD theme demo documentation build configuration file, created by
# sphinx-quickstart on Sun Nov 3 11:56:36 2013.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
sys.path.append(os.path.abspath('.'))
sys.path.append(os.path.abspath('./test_py_module'))
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
]
# Math
mathjax_path = "http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Sphinx RTD theme demo'
copyright = u'2013, Dave Snider'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1'
# The full version, including alpha/beta/rc tags.
release = '1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
# 'sticky_navigation': True # Set to False to disable the sticky nav while scrolling.
# 'logo_only': True, # if we have a html_logo below, this shows /only/ the logo with no title text
}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ["../.."]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
#html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'SphinxRTDthemedemodoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'SphinxRTDthemedemo.tex', u'Sphinx RTD theme demo Documentation',
u'Dave Snider', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'sphinxrtdthemedemo', u'Sphinx RTD theme demo Documentation',
[u'Dave Snider'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'SphinxRTDthemedemo', u'Sphinx RTD theme demo Documentation',
u'Dave Snider', 'SphinxRTDthemedemo', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
-577
View File
@@ -1,577 +0,0 @@
.. This is a comment. Note how any initial comments are moved by
transforms to after the document title, subtitle, and docinfo.
================================
reStructuredText Demonstration
================================
.. Above is the document title, and below is the subtitle.
They are transformed from section titles after parsing.
--------------------------------
Examples of Syntax Constructs
--------------------------------
.. bibliographic fields (which also require a transform):
:Author: David Goodger
:Address: 123 Example Street
Example, EX Canada
A1B 2C3
:Contact: docutils-develop@lists.sourceforge.net
:Authors: Me; Myself; I
:organization: humankind
:date: $Date: 2012-01-03 19:23:53 +0000 (Tue, 03 Jan 2012) $
:status: This is a "work in progress"
:revision: $Revision: 7302 $
:version: 1
:copyright: This document has been placed in the public domain. You
may do with it as you wish. You may copy, modify,
redistribute, reattribute, sell, buy, rent, lease,
destroy, or improve it, quote it at length, excerpt,
incorporate, collate, fold, staple, or mutilate it, or do
anything else to it that your or anyone else's heart
desires.
:field name: This is a generic bibliographic field.
:field name 2:
Generic bibliographic fields may contain multiple body elements.
Like this.
:Dedication:
For Docutils users & co-developers.
:abstract:
This document is a demonstration of the reStructuredText markup
language, containing examples of all basic reStructuredText
constructs and many advanced constructs.
.. meta::
:keywords: reStructuredText, demonstration, demo, parser
:description lang=en: A demonstration of the reStructuredText
markup language, containing examples of all basic
constructs and many advanced constructs.
.. contents:: Table of Contents
.. section-numbering::
Structural Elements
===================
Section Title
-------------
That's it, the text just above this line.
Transitions
-----------
Here's a transition:
---------
It divides the section.
Body Elements
=============
Paragraphs
----------
A paragraph.
Inline Markup
`````````````
Paragraphs contain text and may contain inline markup: *emphasis*,
**strong emphasis**, ``inline literals``, standalone hyperlinks
(http://www.python.org), external hyperlinks (Python_), internal
cross-references (example_), external hyperlinks with embedded URIs
(`Python web site <http://www.python.org>`__), footnote references
(manually numbered [1]_, anonymous auto-numbered [#]_, labeled
auto-numbered [#label]_, or symbolic [*]_), citation references
([CIT2002]_), substitution references (|example|), and _`inline
hyperlink targets` (see Targets_ below for a reference back to here).
Character-level inline markup is also possible (although exceedingly
ugly!) in *re*\ ``Structured``\ *Text*. Problems are indicated by
|problematic| text (generated by processing errors; this one is
intentional).
The default role for interpreted text is `Title Reference`. Here are
some explicit interpreted text roles: a PEP reference (:PEP:`287`); an
RFC reference (:RFC:`2822`); a :sub:`subscript`; a :sup:`superscript`;
and explicit roles for :emphasis:`standard` :strong:`inline`
:literal:`markup`.
.. DO NOT RE-WRAP THE FOLLOWING PARAGRAPH!
Let's test wrapping and whitespace significance in inline literals:
``This is an example of --inline-literal --text, --including some--
strangely--hyphenated-words. Adjust-the-width-of-your-browser-window
to see how the text is wrapped. -- ---- -------- Now note the
spacing between the words of this sentence (words
should be grouped in pairs).``
If the ``--pep-references`` option was supplied, there should be a
live link to PEP 258 here.
Bullet Lists
------------
- A bullet list
+ Nested bullet list.
+ Nested item 2.
- Item 2.
Paragraph 2 of item 2.
* Nested bullet list.
* Nested item 2.
- Third level.
- Item 2.
* Nested item 3.
Enumerated Lists
----------------
1. Arabic numerals.
a) lower alpha)
(i) (lower roman)
A. upper alpha.
I) upper roman)
2. Lists that don't start at 1:
3. Three
4. Four
C. C
D. D
iii. iii
iv. iv
#. List items may also be auto-enumerated.
Definition Lists
----------------
Term
Definition
Term : classifier
Definition paragraph 1.
Definition paragraph 2.
Term
Definition
Field Lists
-----------
:what: Field lists map field names to field bodies, like database
records. They are often part of an extension syntax. They are
an unambiguous variant of RFC 2822 fields.
:how arg1 arg2:
The field marker is a colon, the field name, and a colon.
The field body may contain one or more body elements, indented
relative to the field marker.
Option Lists
------------
For listing command-line options:
-a command-line option "a"
-b file options can have arguments
and long descriptions
--long options can be long also
--input=file long options can also have
arguments
--very-long-option
The description can also start on the next line.
The description may contain multiple body elements,
regardless of where it starts.
-x, -y, -z Multiple options are an "option group".
-v, --verbose Commonly-seen: short & long options.
-1 file, --one=file, --two file
Multiple options with arguments.
/V DOS/VMS-style options too
There must be at least two spaces between the option and the
description.
Literal Blocks
--------------
Literal blocks are indicated with a double-colon ("::") at the end of
the preceding paragraph (over there ``-->``). They can be indented::
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
Or they can be quoted without indentation::
>> Great idea!
>
> Why didn't I think of that?
Line Blocks
-----------
| This is a line block. It ends with a blank line.
| Each new line begins with a vertical bar ("|").
| Line breaks and initial indents are preserved.
| Continuation lines are wrapped portions of long lines;
they begin with a space in place of the vertical bar.
| The left edge of a continuation line need not be aligned with
the left edge of the text above it.
| This is a second line block.
|
| Blank lines are permitted internally, but they must begin with a "|".
Take it away, Eric the Orchestra Leader!
| A one, two, a one two three four
|
| Half a bee, philosophically,
| must, *ipso facto*, half not be.
| But half the bee has got to be,
| *vis a vis* its entity. D'you see?
|
| But can a bee be said to be
| or not to be an entire bee,
| when half the bee is not a bee,
| due to some ancient injury?
|
| Singing...
Block Quotes
------------
Block quotes consist of indented body elements:
My theory by A. Elk. Brackets Miss, brackets. This theory goes
as follows and begins now. All brontosauruses are thin at one
end, much much thicker in the middle and then thin again at the
far end. That is my theory, it is mine, and belongs to me and I
own it, and what it is too.
-- Anne Elk (Miss)
Doctest Blocks
--------------
>>> print 'Python-specific usage examples; begun with ">>>"'
Python-specific usage examples; begun with ">>>"
>>> print '(cut and pasted from interactive Python sessions)'
(cut and pasted from interactive Python sessions)
Tables
------
Here's a grid table followed by a simple table:
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
+========================+============+==========+==========+
| body row 1, column 1 | column 2 | column 3 | column 4 |
+------------------------+------------+----------+----------+
| body row 2 | Cells may span columns. |
+------------------------+------------+---------------------+
| body row 3 | Cells may | - Table cells |
+------------------------+ span rows. | - contain |
| body row 4 | | - body elements. |
+------------------------+------------+----------+----------+
| body row 5 | Cells may also be | |
| | empty: ``-->`` | |
+------------------------+-----------------------+----------+
===== ===== ======
Inputs Output
------------ ------
A B A or B
===== ===== ======
False False False
True False True
False True True
True True True
===== ===== ======
Footnotes
---------
.. [1] A footnote contains body elements, consistently indented by at
least 3 spaces.
This is the footnote's second paragraph.
.. [#label] Footnotes may be numbered, either manually (as in [1]_) or
automatically using a "#"-prefixed label. This footnote has a
label so it can be referred to from multiple places, both as a
footnote reference ([#label]_) and as a hyperlink reference
(label_).
.. [#] This footnote is numbered automatically and anonymously using a
label of "#" only.
.. [*] Footnotes may also use symbols, specified with a "*" label.
Here's a reference to the next footnote: [*]_.
.. [*] This footnote shows the next symbol in the sequence.
.. [4] Here's an unreferenced footnote, with a reference to a
nonexistent footnote: [5]_.
Citations
---------
.. [CIT2002] Citations are text-labeled footnotes. They may be
rendered separately and differently from footnotes.
Here's a reference to the above, [CIT2002]_, and a [nonexistent]_
citation.
Targets
-------
.. _example:
This paragraph is pointed to by the explicit "example" target. A
reference can be found under `Inline Markup`_, above. `Inline
hyperlink targets`_ are also possible.
Section headers are implicit targets, referred to by name. See
Targets_, which is a subsection of `Body Elements`_.
Explicit external targets are interpolated into references such as
"Python_".
.. _Python: http://www.python.org/
Targets may be indirect and anonymous. Thus `this phrase`__ may also
refer to the Targets_ section.
__ Targets_
Here's a `hyperlink reference without a target`_, which generates an
error.
Duplicate Target Names
``````````````````````
Duplicate names in section headers or other implicit targets will
generate "info" (level-1) system messages. Duplicate names in
explicit targets will generate "warning" (level-2) system messages.
Duplicate Target Names
``````````````````````
Since there are two "Duplicate Target Names" section headers, we
cannot uniquely refer to either of them by name. If we try to (like
this: `Duplicate Target Names`_), an error is generated.
Directives
----------
.. contents:: :local:
These are just a sample of the many reStructuredText Directives. For
others, please see
http://docutils.sourceforge.net/docs/ref/rst/directives.html.
Document Parts
``````````````
An example of the "contents" directive can be seen above this section
(a local, untitled table of contents_) and at the beginning of the
document (a document-wide `table of contents`_).
Images
``````
An image directive (also clickable -- a hyperlink reference):
.. image:: images/title.png
:target: directives_
A figure directive:
.. figure:: images/title.png
:alt: reStructuredText, the markup syntax
A figure is an image with a caption and/or a legend:
+------------+-----------------------------------------------+
| re | Revised, revisited, based on 're' module. |
+------------+-----------------------------------------------+
| Structured | Structure-enhanced text, structuredtext. |
+------------+-----------------------------------------------+
| Text | Well it is, isn't it? |
+------------+-----------------------------------------------+
This paragraph is also part of the legend.
A figure directive with center alignment
.. figure:: images/title.png
:align: center
:width: 300
Admonitions
```````````
.. Attention:: Directives at large.
.. Caution::
Don't take any wooden nickels.
.. DANGER:: Mad scientist at work!
.. Error:: Does not compute.
.. Hint:: It's bigger than a bread box.
.. Important::
- Wash behind your ears.
- Clean up your room.
- Call your mother.
- Back up your data.
.. Note:: This is a note.
.. Tip:: 15% if the service is good.
.. WARNING:: Strong prose may provoke extreme mental exertion.
Reader discretion is strongly advised.
.. admonition:: And, by the way...
You can make up your own admonition too.
Topics, Sidebars, and Rubrics
`````````````````````````````
.. sidebar:: Sidebar Title
:subtitle: Optional Subtitle
This is a sidebar. It is for text outside the flow of the main
text.
.. rubric:: This is a rubric inside a sidebar
Sidebars often appears beside the main text with a border and
background color.
.. topic:: Topic Title
This is a topic.
.. rubric:: This is a rubric
Target Footnotes
````````````````
.. target-notes::
Replacement Text
````````````````
I recommend you try |Python|_.
.. |Python| replace:: Python, *the* best language around
Compound Paragraph
``````````````````
.. compound::
This paragraph contains a literal block::
Connecting... OK
Transmitting data... OK
Disconnecting... OK
and thus consists of a simple paragraph, a literal block, and
another simple paragraph. Nonetheless it is semantically *one*
paragraph.
This construct is called a *compound paragraph* and can be produced
with the "compound" directive.
Substitution Definitions
------------------------
An inline image (|example|) example:
.. |EXAMPLE| image:: images/biohazard.png
(Substitution definitions are not visible in the HTML source.)
Comments
--------
Here's one:
.. Comments begin with two dots and a space. Anything may
follow, except for the syntax of footnotes, hyperlink
targets, directives, or substitution definitions.
Double-dashes -- "--" -- must be escaped somehow in HTML output.
(View the HTML source to see the comment.)
Field Lists
===========
:Field List:
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad
minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
some text
:Field List 2: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
Error Handling
==============
Any errors caught during processing will generate system messages.
|*** Expect 6 errors (including this one). ***|
There should be six messages in the following, auto-generated
section, "Docutils System Messages":
.. section should be added by Docutils automatically
demo.rst from: http://docutils.sourceforge.net/docs/user/rst/demo.txt
-222
View File
@@ -1,222 +0,0 @@
.. Sphinx RTD theme demo documentation master file, created by
sphinx-quickstart on Sun Nov 3 11:56:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
=================================================
Demo Docs
=================================================
:Page Status: Incomplete
:Last Reviewed: 2013-10-29
Contents:
.. toctree::
:maxdepth: 2
:caption: Sweet Docs
demo
list
.. toctree::
:maxdepth: 2
:caption: This is an incredibly long caption for a long menu
long
api
Maaaaath!
=========
This is a test. Here is an equation:
:math:`X_{0:5} = (X_0, X_1, X_2, X_3, X_4)`.
Here is another:
.. math::
\nabla^2 f =
\frac{1}{r^2} \frac{\partial}{\partial r}
\left( r^2 \frac{\partial f}{\partial r} \right) +
\frac{1}{r^2 \sin \theta} \frac{\partial f}{\partial \theta}
\left( \sin \theta \, \frac{\partial f}{\partial \theta} \right) +
\frac{1}{r^2 \sin^2\theta} \frac{\partial^2 f}{\partial \phi^2}
Giant tables
============
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
| Header 1 | Header 2 | Header 3 | Header 1 | Header 2 | Header 3 | Header 1 | Header 2 | Header 3 | Header 1 | Header 2 | Header 3 |
+============+============+===========+============+============+===========+============+============+===========+============+============+===========+
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
Optional parameter args
-----------------------
At this point optional parameters `cannot be generated from code`_.
However, some projects will manually do it, like so:
This example comes from `django-payments module docs`_.
.. class:: payments.dotpay.DotpayProvider(seller_id, pin[, channel=0[, lock=False], lang='pl'])
This backend implements payments using a popular Polish gateway, `Dotpay.pl <http://www.dotpay.pl>`_.
Due to API limitations there is no support for transferring purchased items.
:param seller_id: Seller ID assigned by Dotpay
:param pin: PIN assigned by Dotpay
:param channel: Default payment channel (consult reference guide)
:param lang: UI language
:param lock: Whether to disable channels other than the default selected above
.. _cannot be generated from code: https://groups.google.com/forum/#!topic/sphinx-users/_qfsVT5Vxpw
.. _django-payments module docs: http://django-payments.readthedocs.org/en/latest/modules.html#payments.authorizenet.AuthorizeNetProvider
Code test
=========
.. parsed-literal::
# parsed-literal test
curl -O http://someurl/release-|version|.tar-gz
.. code-block:: json
{
"windows": [
{
"panes": [
{
"shell_command": [
"echo 'did you know'",
"echo 'you can inline'"
]
},
{
"shell_command": "echo 'single commands'"
},
"echo 'for panes'"
],
"window_name": "long form"
}
],
"session_name": "shorthands"
}
Sidebar
=======
.. sidebar:: Ch'ien / The Creative
.. image:: static/yi_jing_01_chien.jpg
*Above* CH'IEN THE CREATIVE, HEAVEN
*Below* CH'IEN THE CREATIVE, HEAVEN
The first hexagram is made up of six unbroken lines. These unbroken lines stand for the primal power, which is light-giving, active, strong, and of the spirit. The hexagram is consistently strong in character, and since it is without weakness, its essence is power or energy. Its image is heaven. Its energy is represented as unrestricted by any fixed conditions in space and is therefore conceived of as motion. Time is regarded as the basis of this motion. Thus the hexagram includes also the power of time and the power of persisting in time, that is, duration.
The power represented by the hexagram is to be interpreted in a dual sense in terms of its action on the universe and of its action on the world of men. In relation to the universe, the hexagram expresses the strong, creative action of the Deity. In relation to the human world, it denotes the creative action of the holy man or sage, of the ruler or leader of men, who through his power awakens and develops their higher nature.
Code with Sidebar
=================
.. sidebar:: A code example
With a sidebar on the right.
.. literalinclude:: test_py_module/test.py
:language: python
:linenos:
:lines: 1-40
Boxes
=====
.. tip::
Equations within a note
:math:`G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})`.
.. note::
Equations within a note
:math:`G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})`.
.. danger::
Equations within a note
:math:`G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})`.
.. warning::
Equations within a note
:math:`G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})`.
Inline code and references
==========================
`reStructuredText`_ is a markup language. It can use roles and
declarations to turn reST into HTML.
In reST, ``*hello world*`` becomes ``<em>hello world</em>``. This is
because a library called `Docutils`_ was able to parse the reST and use a
``Writer`` to output it that way.
If I type ````an inline literal```` it will wrap it in ``<tt>``. You can
see more details on the `Inline Markup`_ on the Docutils homepage.
Also with ``sphinx.ext.autodoc``, which I use in the demo, I can link to
:class:`test_py_module.test.Foo`. It will link you right my code
documentation for it.
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Docutils: http://docutils.sourceforge.net/
.. _Inline Markup: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup
.. note:: Every other line in this table will have white text on a white background.
This is bad.
+---------+
| Example |
+=========+
| Thing1 |
+---------+
| Thing2 |
+---------+
| Thing3 |
+---------+
Emphasized lines with line numbers
==================================
.. code-block:: python
:linenos:
:emphasize-lines: 3,5
def some_function():
interesting = False
print 'This line is highlighted.'
print 'This one is not...'
print '...but this one is.'
Citation
========
Here I am making a citation [1]_
.. [1] This is the citation I made, let's make this extremely long so that we can tell that it doesn't follow the normal responsive table stuff.
Download links
==============
:download:`This long long long long long long long long long long long long long long long download link should be blue with icon, and should wrap white-spaces <static/yi_jing_01_chien.jpg>`
-69
View File
@@ -1,69 +0,0 @@
.. important::
wanna play a game?
- inside
- this
- list
- ``in the world``
- hi
- his
hi
A list
======
- here
- is
- some
- list
- items
- `yahoo <http://www.yahoo.com>`_
- ``huh``
- how
- ``inline literall``
- ``inline literall``
- ``inline literall``
Second list level
-----------------
- here is a list in a second-level section.
- `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_
- here is an inner bullet ``oh``
- one more ``with an inline literally``. `yahoo <http://www.yahoo.com>`_
heh heh. child. try to beat this embed:
.. literalinclude:: test_py_module/test.py
:language: python
:linenos:
:lines: 1-10
- and another. `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_
- ``hi``
- and hehe
But deeper down the rabbit hole
"""""""""""""""""""""""""""""""
- I kept saying that, "deeper down the rabbit hole". `yahoo <http://www.yahoo.com>`_
- I cackle at night `yahoo <http://www.yahoo.com>`_.
- I'm so lonely here in GZ ``guangzhou``
- A man of python destiny, hopes and dreams. `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_ ``hi``
- ``destiny``
Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.3 KiB

+20
View File
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = ReadtheDocsSphinxTheme
SOURCEDIR = .
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# 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)
+210
View File
@@ -0,0 +1,210 @@
*********
Changelog
*********
master
======
New Features
-------------
Fixes
-----
Other Changes
--------------
0.4.3
======
:Date: Feb 12, 2019
New Features
-------------
Fixes
-----
* Fix scrolling to active item in sidebar on load (#214)
* Style caption link for code and literal blocks
* Fix inconsistent font size and line height for autodoc "raises" and "returns" (#267)
* Fix last_updated notice appearing in same line as copyright notice (#704)
Other Changes
--------------
v0.4.2
======
:Date: Oct 5, 2018
New Features
-------------
Fixes
-----
* Set base font size on <html> (#668)
* Fix HTML search not working with Sphinx-1.8 (#672)
Other Changes
--------------
* Upload signed packages to PyPI with twine (#651)
* Do not enforce period at the end of copyright statement (666)
v0.4.1
======
:Date: July 27, 2018
New Features
-------------
Fixes
-----
* Line height adjustments for Liberation Mono (#656)
Other Changes
--------------
* Add Sphinx as a dependency
v0.4.0
======
This version made some changes to how JS and CSS were included
when the theme is used on Read the Docs.
New Features
-------------
Fixes
-----
* Do not rely on readthedocs.org for CSS/JS (#614)
* Color accessibility improvements on the left navigation
Other Changes
--------------
* Write theme version and build date at top of JavaScript and CSS
* Changed code and literals to use a native font stack (#612)
* Fix small styling issues
v0.3.1
======
Fixes
-----
* Revert part of #576 causing display issues with version selector menu
* Backwards compatibility fixes for pre-0.3.0 releases (#623)
* Fix mkdocs version selector (#622)
* Add open list spacing (#591)
* Fix table centering (#599)
v0.3.0
======
**Note**: this version resulted in some JavaScript incompatibilities when used on readthedocs.org
New Features
-------------
* Add html language attribute
* Allow setting 'rel' and 'title' attributes for stylesheets (#551)
* Add option to style external links
* Add github, gitlab, bitbucket page arguments option
* Add pygments support
* Add setuptools entry point allowing to use ``sphinx_rtd_theme`` as
Sphinx ``html_theme`` directly.
* Add language to the JS output variable
Fixes
-----
* Fix some HTML warnings and errors
* Fix many styling issues
* Fix many sidebar glitches
* Fix line number spacing to align with the code lines
* Hide Edit links on auto created pages
* Include missing font files with the theme
Other Changes
--------------
* Significant improvement of our documentation
* Compress our Javascript files
* Updated dependencies
v0.2.4
======
* Yet another patch to deal with extra builders outside Spinx, such as the
singlehtml builders from the Read the Docs Sphinx extension
v0.2.3
======
* Temporarily patch Sphinx issue with ``singlehtml`` builder by inspecting the
builder in template.
v0.2.2
======
* Roll back toctree fix in 0.2.1 (#367). This didn't fix the issue and
introduced another bug with toctrees display.
v0.2.1
======
* Add the ``rel`` HTML attribute to the footer links which point to
the previous and next pages.
* Fix toctree issue caused by Sphinx singlehtml builder (#367)
v0.2.0
======
* Adds the ``comments`` block after the ``body`` block in the template
* Added "Edit on GitLab" support
* Many bug fixes
v0.1.10-alpha
=============
.. note:: This is a pre-release version
* Removes Sphinx dependency
* Fixes hamburger on mobile display
* Adds a ``body_begin`` block to the template
* Added ``prev_next_buttons_location``
v0.1.9
======
* Intermittent scrollbar visibility bug fixed. This change introduces a
backwards incompatible change to the theme's layout HTML. This should only be
a problem for derivative themes that have overridden styling of nav elements
using direct descendant selectors. See `#215`_ for more information.
* Safari overscroll bug fixed
* Version added to the nav header
* Revision id was added to the documentation footer if you are using RTD
* An extra block, ``extrafooter`` was added to allow extra content in the
document footer block
* Fixed modernizr URL
* Small display style changes on code blocks, figure captions, and nav elements
.. _#215: https://github.com/rtfd/sphinx_rtd_theme/pull/215
v0.1.8
======
* Start keeping changelog :)
* Support for third and fourth level headers in the sidebar
* Add support for Sphinx 1.3
* Add sidebar headers for :caption: in Sphinx toctree
* Clean up sidebar scrolling behavior so it never scrolls out of view
+92
View File
@@ -0,0 +1,92 @@
# -*- coding: utf-8 -*-
import sys
import os
import re
sys.path.append(os.path.abspath('..'))
sys.path.append(os.path.abspath('./demo/'))
from sphinx.locale import _
from sphinx_rtd_theme import __version__
project = u'Read the Docs Sphinx Theme'
slug = re.sub(r'\W+', '-', project.lower())
version = __version__
release = __version__
author = u'Dave Snider, Read the Docs, Inc. & contributors'
copyright = author
language = 'en'
extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinxcontrib.httpdomain',
]
templates_path = ['_templates']
source_suffix = '.rst'
exclude_patterns = []
master_doc = 'index'
suppress_warnings = ['image.nonlocal_uri']
pygments_style = 'default'
intersphinx_mapping = {
'rtd': ('https://docs.readthedocs.io/en/latest/', None),
'sphinx': ('http://www.sphinx-doc.org/en/stable/', None),
}
html_theme = 'sphinx_rtd_theme'
html_theme_options = {
'logo_only': True
}
html_theme_path = ["../.."]
html_logo = "demo/static/logo-wordmark-light.svg"
html_show_sourcelink = True
htmlhelp_basename = slug
latex_documents = [
('index', '{0}.tex'.format(slug), project, author, 'manual'),
]
man_pages = [
('index', slug, project, [author], 1)
]
texinfo_documents = [
('index', slug, project, author, slug, project, 'Miscellaneous'),
]
# Extensions to theme docs
def setup(app):
from sphinx.domains.python import PyField
from sphinx.util.docfields import Field
app.add_object_type(
'confval',
'confval',
objname='configuration value',
indextemplate='pair: %s; configuration value',
doc_field_types=[
PyField(
'type',
label=_('Type'),
has_arg=False,
names=('type',),
bodyrolename='class'
),
Field(
'default',
label=_('Default'),
has_arg=False,
names=('default',),
),
]
)
+226
View File
@@ -0,0 +1,226 @@
*************
Configuration
*************
Theme options
=============
The following options can be defined in your project's ``conf.py`` file, using
the :confval:`html_theme_options <sphinx:html_theme_options>` configuration option.
For example:
.. code:: python
html_theme_options = {
'canonical_url': '',
'analytics_id': 'UA-XXXXXXX-1', # Provided by Google in your dashboard
'logo_only': False,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
'style_nav_header_background': 'white',
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False
}
Table of contents options
-------------------------
The following options change how :rst:dir:`sphinx:toctree` directives generate
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.
.. confval:: sticky_navigation
: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: boolean
:default: ``True``
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
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.
.. _table of contents configuration options: http://www.sphinx-doc.org/en/stable/templating.html#toctree
..
TODO
.
HTML context options
~~~~~~~~~~~~~~~~~~~~
Miscellaneous options
---------------------
.. confval:: analytics_id
:type: string
Change the Google Analytics ID that is included on pages.
.. warning::
This configuration option is not yet used.
.. 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.
.. confval:: display_version
: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: string
:default: ``bottom``
Location to display :guilabel:`Next` and :guilabel:`Previous` buttons. This
can be either ``bottom``, ``top``, ``both`` , or ``None``.
.. confval:: style_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``.
.. confval:: style_nav_header_background
: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.
.. _canonical URL: https://en.wikipedia.org/wiki/Canonical_link_element
File-wide metadata
==================
The following options can be used as :ref:`file-wide metadata
<sphinx:metadata>`:
.. confval:: github_url
Force the :guilabel:`Edit on GitHub` button to use the configured URL.
.. confval:: bitbucket_url
Force the :guilabel:`Edit on Bitbucket` button to use the configured URL.
.. confval:: gitlab_url
Force the :guilabel:`Edit on GitLab` button to use the configured URL.
Other configuration
===================
Adding a logo
-------------
Using the Sphinx standard option :py:confval:`html_logo <sphinx:html_logo>`,
you can set an image file to be used as a logo at the top of the sidebar. The
theme option :py:confval:`logo_only` also allows for *only* the logo to be shown
at the top of the sidebar.
Adding custom CSS or Javascript
-------------------------------
Adding custom CSS or Javascript can help you alter the look and feel of this
theme without forking the theme for local use.
In order to add custom CSS or Javascript without disrupting the existing theme
files, you can :doc:`add files to be included in your documentation output
<rtd:guides/adding-custom-css>`.
How the table of contents displays
==================================
Currently the left menu will build based upon any ``toctree`` directives defined
in your source files. It outputs 4 levels of depth by default, to allow for
quick navigation through topics. If no TOC trees are defined, Sphinx's default
behavior is to use the page headings instead.
It's important to note that if you don't follow the same styling for your reST
headings across your documents, the TOC tree will build incorrectly, and the
resulting menu might not show the correct depth when it renders.
Also note that by default the table of contents is set with
``includehidden=True``. This allows you to set a hidden TOC in your index file
with the :ref:`:hidden: <sphinx:toctree-directive>` property that will allow you
to build a TOC without it rendering in your index.
By default, the navigation will "stick" to the screen as you scroll. However if
your TOC is not tall enough, it will revert to static positioning. To disable the
sticky navigation altogether, change the :confval:`sticky_navigation` theme option.
+89
View File
@@ -0,0 +1,89 @@
***********************************
Contributing or modifying the theme
***********************************
The sphinx_rtd_theme is primarily a sass_ project that requires a few other sass libraries. I'm
using bower_ to manage these dependencies and sass_ to build the css. The good news is
I have a very nice set of grunt_ operations that will not only load these dependencies, but watch
for changes, rebuild the sphinx demo docs and build a distributable version of the theme.
The bad news is this means you'll need to set up your environment similar to that
of a front-end developer (vs. that of a python developer). That means installing node and ruby.
.. seealso::
If you are unsure of appropriate actions to take while interacting with our
community please read our :doc:`Code of Conduct <rtd:code-of-conduct>`.
Set up your environment
=======================
#. Install sphinx_ into a virtual environment.
.. code:: bash
pip install sphinx sphinxcontrib-httpdomain
#. Install sass.
.. code:: bash
gem install sass
#. Install node, bower, grunt, and theme dependencies.
.. code:: bash
# Install node
brew install node
# Install bower and grunt
npm install -g bower grunt-cli
# Now that everything is installed, let's install the theme dependencies.
npm install
Now that our environment is set up, make sure you're in your virtual environment, go to
this repository in your terminal and run grunt:
.. code::
grunt
This default task will do the following **very cool things that make it worth the trouble**:
#. Install and update any bower dependencies.
#. Run sphinx and build new docs.
#. Watch for changes to the sass files and build css from the changes.
#. Rebuild the sphinx docs anytime it notices a change to ``.rst``, ``.html``, ``.js``
or ``.css`` files.
.. _bower: http://www.bower.io
.. _sass: http://www.sass-lang.com
.. _wyrm: http://www.github.com/snide/wyrm/
.. _grunt: http://www.gruntjs.com
.. _node: http://www.nodejs.com
.. _sphinx: http://www.sphinx-doc.org/en/stable/
Releasing the Theme
===================
When you release a new version,
you should do the following:
#. Bump the version in ``sphinx_rtd_theme/__init__.py``, ``bower.json`` and ``package.json`` --
we try to follow `semver <http://semver.org/>`_, so be careful with breaking changes.
#. Update the changelog (``docs/changelog.rst``) with the version information.
#. Run a ``grunt build`` to rebuild all the theme assets.
#. Commit that change.
#. Tag the release in git: ``git tag $NEW_VERSION``.
#. Push the tag to GitHub: ``git push --tags origin``.
#. Upload the package to PyPI:
.. code:: bash
$ rm -rf dist/
$ python setup.py sdist bdist_wheel
$ twine upload --sign --identity security@readthedocs.org dist/*
+53
View File
@@ -0,0 +1,53 @@
*********************
:mod:`test_py_module`
*********************
.. contents:: Table of Contents
.. automodule:: test_py_module.test
:members:
:private-members:
:special-members:
Generated Index
===============
Part of the sphinx build process in generate and index file: :ref:`genindex`.
Optional parameter args
=======================
At this point optional parameters `cannot be generated from code`_.
However, some projects will manually do it, like so:
This example comes from `django-payments module docs`_.
.. class:: payments.dotpay.DotpayProvider(seller_id, pin[, channel=0[, lock=False], lang='pl'])
This backend implements payments using a popular Polish gateway, `Dotpay.pl <http://www.dotpay.pl>`_.
Due to API limitations there is no support for transferring purchased items.
:param seller_id: Seller ID assigned by Dotpay
:param pin: PIN assigned by Dotpay
:param channel: Default payment channel (consult reference guide)
:param lang: UI language
:param lock: Whether to disable channels other than the default selected above
.. _cannot be generated from code: https://groups.google.com/forum/#!topic/sphinx-users/_qfsVT5Vxpw
.. _django-payments module docs: http://django-payments.readthedocs.org/en/latest/modules.html#payments.authorizenet.AuthorizeNetProvide
Data
====
.. data:: Data_item_1
Data_item_2
Data_item_3
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce congue elit eu hendrerit mattis.
Some data link :data:`Data_item_1`.
+475
View File
@@ -0,0 +1,475 @@
.. This is a comment. Note how any initial comments are moved by
transforms to after the document title, subtitle, and docinfo.
.. demo.rst from: http://docutils.sourceforge.net/docs/user/rst/demo.txt
.. |EXAMPLE| image:: static/yi_jing_01_chien.jpg
:width: 1em
**********************
Paragraph Level Markup
**********************
.. contents:: Table of Contents
Inline Markup
=============
Paragraphs contain text and may contain inline markup: *emphasis*, **strong emphasis**, ``inline literals``,
standalone hyperlinks (http://www.python.org), external hyperlinks (Python_), internal cross-references (example_),
external hyperlinks with embedded URIs (`Python web site <http://www.python.org>`__), footnote references
(manually numbered [1]_, anonymous auto-numbered [#]_, labeled auto-numbered [#label]_, or symbolic [*]_),
citation references ([12]_), substitution references (|example|), and _`inline hyperlink targets`
(see Targets_ below for a reference back to here). Character-level inline markup is also possible
(although exceedingly ugly!) in *re*\ ``Structured``\ *Text*. Problems are indicated by |problematic|
text (generated by processing errors; this one is intentional).
Also with ``sphinx.ext.autodoc``, which I use in the demo, I can link to :class:`test_py_module.test.Foo`.
It will link you right my code documentation for it.
The default role for interpreted text is `Title Reference`. Here are some explicit interpreted text roles:
a PEP reference (:PEP:`287`); an RFC reference (:RFC:`2822`); a :sub:`subscript`; a :sup:`superscript`;
and explicit roles for :emphasis:`standard` :strong:`inline` :literal:`markup`.
GUI labels are a useful way to indicate that :guilabel:`Some action` is to be taken by the user.
The GUI label should not run over ``line-height`` so as not to :guilabel:`interfere` with text from adjacent lines.
Key-bindings indicate that the read is to press a button on the keyboard or mouse,
for example :kbd:`MMB` and :kbd:`Shift-MMB`. Another useful markup to indicate a user action
is to use ``menuselection`` this can be used to show short and long menus in software.
For example, and ``menuselection`` can be seen here that breaks is too long to fit on this line.
:menuselection:`My --> Software --> Some menu --> Some sub menu 1 --> sub menu 2`.
.. DO NOT RE-WRAP THE FOLLOWING PARAGRAPH!
Let's test wrapping and whitespace significance in inline literals:
``This is an example of --inline-literal --text, --including some--
strangely--hyphenated-words. Adjust-the-width-of-your-browser-window
to see how the text is wrapped. -- ---- -------- Now note the
spacing between the words of this sentence (words
should be grouped in pairs).``
If the ``--pep-references`` option was supplied, there should be a live link to PEP 258 here.
Math
====
This is a test. Here is an equation:
:math:`X_{0:5} = (X_0, X_1, X_2, X_3, X_4)`.
Here is another:
.. math::
:label: This is a label
\nabla^2 f =
\frac{1}{r^2} \frac{\partial}{\partial r}
\left( r^2 \frac{\partial f}{\partial r} \right) +
\frac{1}{r^2 \sin \theta} \frac{\partial f}{\partial \theta}
\left( \sin \theta \, \frac{\partial f}{\partial \theta} \right) +
\frac{1}{r^2 \sin^2\theta} \frac{\partial^2 f}{\partial \phi^2}
You can add a link to equations like the one above :eq:`This is a label` by using ``:eq:``.
Meta
====
.. meta::
:keywords: reStructuredText, demonstration, demo, parser
:description lang=en: A demonstration of the reStructuredText
markup language, containing examples of all basic
constructs and many advanced constructs.
Blocks
======
Literal Blocks
--------------
Literal blocks are indicated with a double-colon ("::") at the end of
the preceding paragraph (over there ``-->``). They can be indented::
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
Or they can be quoted without indentation::
>> Great idea!
>
> Why didn't I think of that?
Line Blocks
-----------
| This is a line block. It ends with a blank line.
| Each new line begins with a vertical bar ("|").
| Line breaks and initial indents are preserved.
| Continuation lines are wrapped portions of long lines;
they begin with a space in place of the vertical bar.
| The left edge of a continuation line need not be aligned with
the left edge of the text above it.
| This is a second line block.
|
| Blank lines are permitted internally, but they must begin with a "|".
Take it away, Eric the Orchestra Leader!
| A one, two, a one two three four
|
| Half a bee, philosophically,
| must, *ipso facto*, half not be.
| But half the bee has got to be,
| *vis a vis* its entity. D'you see?
|
| But can a bee be said to be
| or not to be an entire bee,
| when half the bee is not a bee,
| due to some ancient injury?
|
| Singing...
Block Quotes
------------
Block quotes consist of indented body elements:
My theory by A. Elk. Brackets Miss, brackets. This theory goes
as follows and begins now. All brontosauruses are thin at one
end, much much thicker in the middle and then thin again at the
far end. That is my theory, it is mine, and belongs to me and I
own it, and what it is too.
-- Anne Elk (Miss)
Doctest Blocks
--------------
>>> print 'Python-specific usage examples; begun with ">>>"'
Python-specific usage examples; begun with ">>>"
>>> print '(cut and pasted from interactive Python sessions)'
(cut and pasted from interactive Python sessions)
Code Blocks
-----------
.. parsed-literal::
# parsed-literal test
curl -O http://someurl/release-|version|.tar-gz
.. code-block:: json
:caption: Code Blocks can have captions.
{
"windows": [
{
"panes": [
{
"shell_command": [
"echo 'did you know'",
"echo 'you can inline'"
]
},
{
"shell_command": "echo 'single commands'"
},
"echo 'for panes'"
],
"window_name": "long form"
}
],
"session_name": "shorthands"
}
Emphasized lines with line numbers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: python
:linenos:
:emphasize-lines: 3,5
def some_function():
interesting = False
print 'This line is highlighted.'
print 'This one is not...'
print '...but this one is.'
Sidebar
=======
.. sidebar:: Ch'ien / The Creative
.. image:: static/yi_jing_01_chien.jpg
*Above* CH'IEN THE CREATIVE, HEAVEN
*Below* CH'IEN THE CREATIVE, HEAVEN
The first hexagram is made up of six unbroken lines. These unbroken lines stand for the primal power,
which is light-giving, active, strong, and of the spirit. The hexagram is consistently strong in character,
and since it is without weakness, its essence is power or energy. Its image is heaven.
Its energy is represented as unrestricted by any fixed conditions in space and is therefore conceived of as motion.
Time is regarded as the basis of this motion.
Thus the hexagram includes also the power of time and the power of persisting in time, that is, duration.
The power represented by the hexagram is to be interpreted in a dual sense in terms of its action
on the universe and of its action on the world of men. In relation to the universe, the hexagram expresses the strong,
creative action of the Deity. In relation to the human world, it denotes the creative action of the holy man or sage,
of the ruler or leader of men, who through his power awakens and develops their higher nature.
Code with Sidebar
-----------------
.. sidebar:: A code example
With a sidebar on the right.
.. literalinclude:: test_py_module/test.py
:language: python
:caption: Literal includes can also have captions.
:linenos:
:lines: 1-40
References
==========
Footnotes
---------
.. [1] A footnote contains body elements, consistently indented by at
least 3 spaces.
This is the footnote's second paragraph.
.. [#label] Footnotes may be numbered, either manually (as in [1]_) or
automatically using a "#"-prefixed label. This footnote has a
label so it can be referred to from multiple places, both as a
footnote reference ([#label]_) and as a hyperlink reference
(label_).
.. [#] This footnote is numbered automatically and anonymously using a
label of "#" only.
.. [*] Footnotes may also use symbols, specified with a "*" label.
Here's a reference to the next footnote: [*]_.
.. [*] This footnote shows the next symbol in the sequence.
.. [4] Here's an unreferenced footnote, with a reference to a
nonexistent footnote: [5]_.
Citations
---------
.. [11] This is the citation I made, let's make this extremely long so that we can tell that it doesn't follow the normal responsive table stuff.
.. [12] This citation has some ``code blocks`` in it, maybe some **bold** and
*italics* too. Heck, lets put a link to a meta citation [13]_ too.
.. [13] This citation will have two backlinks.
Here's a reference to the above, [12]_, and a [nonexistent]_ citation.
Here is another type of citation: `citation`
Glossary
--------
This is a glossary with definition terms for thing like :term:`Writing`:
.. glossary::
Documentation
Provides users with the knowledge they need to use something.
Reading
The process of taking information into ones mind through the use of eyes.
Writing
The process of putting thoughts into a medium for other people to :term:`read <Reading>`.
Targets
-------
.. _example:
This paragraph is pointed to by the explicit "example" target.
A reference can be found under `Inline Markup`_, above. `Inline
hyperlink targets`_ are also possible.
Section headers are implicit targets, referred to by name. See
Targets_, which is a subsection of `Body Elements`_.
Explicit external targets are interpolated into references such as "Python_".
.. _Python: http://www.python.org/
Targets may be indirect and anonymous. Thus `this phrase`__ may also
refer to the Targets_ section.
__ Targets_
Here's a `hyperlink reference without a target`_, which generates an error.
Directives
==========
Contents
--------
.. contents:: :local:
These are just a sample of the many reStructuredText Directives. For others, please see:
http://docutils.sourceforge.net/docs/ref/rst/directives.html.
Centered text
-------------
You can create a statement with centered text with ``.. centered::``
.. centered:: This is centered text!
Images & Figures
----------------
Images
^^^^^^
An image directive (also clickable -- a hyperlink reference):
.. image:: static/yi_jing_01_chien.jpg
:target: directives_
Figures
^^^^^^^
.. figure:: static/yi_jing_01_chien.jpg
:alt: reStructuredText, the markup syntax
A figure is an image with a caption and/or a legend:
+------------+-----------------------------------------------+
| re | Revised, revisited, based on 're' module. |
+------------+-----------------------------------------------+
| Structured | Structure-enhanced text, structuredtext. |
+------------+-----------------------------------------------+
| Text | Well it is, isn't it? |
+------------+-----------------------------------------------+
This paragraph is also part of the legend.
A figure directive with center alignment
.. figure:: static/yi_jing_01_chien.jpg
:align: center
This caption should be centered.
Admonitions
-----------
.. Attention:: Directives at large.
.. Caution:: Don't take any wooden nickels.
.. DANGER:: Mad scientist at work!
.. Error:: Does not compute.
.. Hint:: It's bigger than a bread box.
.. Important::
- Wash behind your ears.
- Clean up your room.
- Including the closet.
- The bathroom too.
- Take the trash out of the bathroom.
- Clean the sink.
- Call your mother.
- Back up your data.
.. Note:: This is a note.
Equations within a note:
:math:`G_{\mu\nu} = 8 \pi G (T_{\mu\nu} + \rho_\Lambda g_{\mu\nu})`.
.. Tip:: 15% if the service is good.
+---------+
| Example |
+=========+
| Thing1 |
+---------+
| Thing2 |
+---------+
| Thing3 |
+---------+
.. WARNING:: Strong prose may provoke extreme mental exertion.
Reader discretion is strongly advised.
.. admonition:: And, by the way...
You can make up your own admonition too.
Topics, Sidebars, and Rubrics
-----------------------------
.. sidebar:: Sidebar Title
:subtitle: Optional Subtitle
This is a sidebar. It is for text outside the flow of the main
text.
.. rubric:: This is a rubric inside a sidebar
Sidebars often appears beside the main text with a border and
background color.
.. topic:: Topic Title
This is a topic.
.. rubric:: This is a rubric
Target Footnotes
----------------
.. target-notes::
Replacement Text
----------------
I recommend you try |Python|_.
.. |Python| replace:: Python, *the* best language around
Compound Paragraph
------------------
.. compound::
This paragraph contains a literal block::
Connecting... OK
Transmitting data... OK
Disconnecting... OK
and thus consists of a simple paragraph, a literal block, and
another simple paragraph. Nonetheless it is semantically *one*
paragraph.
This construct is called a *compound paragraph* and can be produced
with the "compound" directive.
Download Links
==============
:download:`This long long long long long long long long long long long long long long long download link should be blue, normal weight text with a leading icon, and should wrap white-spaces <static/yi_jing_01_chien.jpg>`
+302
View File
@@ -0,0 +1,302 @@
**************
Lists & Tables
**************
.. contents:: Table of Contents
Lists
=====
Enumerated Lists
----------------
1. Arabic numerals.
a) lower alpha)
(i) (lower roman)
A. upper alpha.
I) upper roman)
2. Lists that don't start at 1:
3. Three
4. Four
C. C
D. D
iii. iii
iv. iv
#. List items may also be auto-enumerated.
Definition Lists
----------------
Term
Definition
Term : classifier
Definition paragraph 1.
Definition paragraph 2.
Term
Definition
Option Lists
------------
For listing command-line options:
-a command-line option "a"
-b file options can have arguments
and long descriptions
--long options can be long also
--input=file long options can also have
arguments
--very-long-option
The description can also start on the next line.
The description may contain multiple body elements,
regardless of where it starts.
-x, -y, -z Multiple options are an "option group".
-v, --verbose Commonly-seen: short & long options.
-1 file, --one=file, --two file
Multiple options with arguments.
/V DOS/VMS-style options too
There must be at least two spaces between the option and the description.
Field list
----------
.. bibliographic fields (which also require a transform):
:Author: David Goodger
:Address: 123 Example Street
Example, EX Canada
A1B 2C3
:Contact: docutils-develop@lists.sourceforge.net
:Authors: Me; Myself; I
:organization: humankind
:date: $Date: 2012-01-03 19:23:53 +0000 (Tue, 03 Jan 2012) $
:status: This is a "work in progress"
:revision: $Revision: 7302 $
:version: 1
:copyright: This document has been placed in the public domain. You
may do with it as you wish. You may copy, modify,
redistribute, reattribute, sell, buy, rent, lease,
destroy, or improve it, quote it at length, excerpt,
incorporate, collate, fold, staple, or mutilate it, or do
anything else to it that your or anyone else's heart
desires.
:field name: This is a generic bibliographic field.
:field name 2:
Generic bibliographic fields may contain multiple body elements.
Like this.
:Dedication:
For Docutils users & co-developers.
:abstract:
This document is a demonstration of the reStructuredText markup
language, containing examples of all basic reStructuredText
constructs and many advanced constructs.
Bullet Lists
------------
- A bullet list
+ Nested bullet list.
+ Nested item 2.
- Item 2.
Paragraph 2 of item 2.
* Nested bullet list.
* Nested item 2.
- Third level.
- Item 2.
* Nested item 3.
- ``inline literall``
- ``inline literall``
- ``inline literall``
Second list level
^^^^^^^^^^^^^^^^^
- here is a list in a second-level section.
- `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_
- here is an inner bullet ``oh``
- one more ``with an inline literally``. `yahoo <http://www.yahoo.com>`_
heh heh. child. try to beat this embed:
.. literalinclude:: test_py_module/test.py
:language: python
:linenos:
:lines: 1-10
- and another. `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_
- ``hi``
- and hehe
But deeper down the rabbit hole
"""""""""""""""""""""""""""""""
- I kept saying that, "deeper down the rabbit hole". `yahoo <http://www.yahoo.com>`_
- I cackle at night `yahoo <http://www.yahoo.com>`_.
- I'm so lonely here in GZ ``guangzhou``
- A man of python destiny, hopes and dreams. `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_ ``hi``
- ``destiny``
Hlists
------
.. hlist::
:columns: 2
- First item
- Second item
- Third item
- Forth item
- Fifth item
- Sixths item
.. rubric:: Hlist with images
.. hlist::
:columns: 2
- .. figure:: static/yi_jing_01_chien.jpg
This is a short caption for a figure.
- .. figure:: static/yi_jing_01_chien.jpg
This is a long caption for a figure. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Donec porttitor dolor in odio posuere, vitae ornare libero mattis. In lobortis justo vestibulum nibh aliquet, non.
Numbered List
-------------
#. One,
#. Two.
#. Three with long text. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Sed feugiat sagittis neque quis eleifend. Duis rutrum lectus sit amet mattis suscipit.
- A) Using bullets and letters. (A)
- B) Using bullets and letters. (B)
- C) Using bullets and letters. (C)
Tables
======
Grid Tables
-----------
Here's a grid table followed by a simple table:
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
+========================+============+==========+==========+
| body row 1, column 1 | column 2 | column 3 | column 4 |
+------------------------+------------+----------+----------+
| body row 2 | Cells may span columns. |
+------------------------+------------+---------------------+
| body row 3 | Cells may | - Table cells |
+------------------------+ span rows. | - contain |
| body row 4 | | - body elements. |
+------------------------+------------+----------+----------+
| body row 5 | Cells may also be | |
| | empty: ``-->`` | |
+------------------------+-----------------------+----------+
===== ===== ======
Inputs Output
------------ ------
A B A or B
===== ===== ======
False False False
True False True
False True True
True True True
===== ===== ======
Giant Tables
^^^^^^^^^^^^
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
| Header 1 | Header 2 | Header 3 | Header 1 | Header 2 | Header 3 | Header 1 | Header 2 | Header 3 | Header 1 | Header 2 | Header 3 |
+============+============+===========+============+============+===========+============+============+===========+============+============+===========+
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+
List Tables
-----------
.. list-table:: List tables can have captions like this one.
:widths: 10 5 10 50
:header-rows: 1
:stub-columns: 1
* - List table
- Header 1
- Header 2
- Header 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu.
* - Stub Row 1
- Row 1
- Column 2
- Column 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu.
* - Stub Row 2
- Row 2
- Column 2
- Column 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu.
* - Stub Row 3
- Row 3
- Column 2
- Column 3 long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam sit amet mauris arcu.
.. list-table:: This is a list table with images in it.
* - .. figure:: static/yi_jing_01_chien.jpg
This is a short caption for a figure.
- .. figure:: static/yi_jing_01_chien.jpg
This is a long caption for a figure. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Donec porttitor dolor in odio posuere, vitae ornare libero mattis. In lobortis justo vestibulum nibh aliquet, non.
@@ -1,209 +1,214 @@
Long Sticky Nav
===============
This section demonstrates how the 'sticky_navigation' setting behaves when the menu is very long. When this section is selected, it will make the menu and the main area scroll when you are at the top of the page.
***************
Long Sticky Nav
***************
.. contents:: Table of Contents
This section demonstrates how the 'sticky_navigation' setting behaves when the menu is very long.
When this section is selected, it will make the menu and the main area scroll when you are at the top of the page.
Example Menu 1
--------------
==============
Just a place holder...
Example Menu 2
--------------
==============
Just a place holder...
Example Menu 3
--------------
==============
Just a place holder...
Example Menu 4
--------------
==============
Just a place holder...
Example Menu 5
--------------
==============
Just a place holder...
Example Menu 6
--------------
==============
Just a place holder...
Example Menu 7
--------------
==============
Just a place holder...
Example Menu 8
--------------
==============
Just a place holder...
Example Menu 9
--------------
==============
Just a place holder...
Example Menu 10
---------------
===============
Just a place holder...
Example Menu 11
---------------
===============
Just a place holder...
Example Menu 12
---------------
===============
Just a place holder...
Example Menu 13
---------------
===============
Just a place holder...
Example Menu 14
---------------
===============
Just a place holder...
Example Menu 15
---------------
===============
Just a place holder...
Example Menu 16
---------------
===============
Just a place holder...
Example Menu 17
---------------
===============
Just a place holder...
Example Menu 18
---------------
===============
Just a place holder...
Example Menu 19
---------------
===============
Just a place holder...
Example Menu 20
---------------
===============
Just a place holder...
Example Submenu 1
-----------------
=================
Just a place holder...
Submenu 1
~~~~~~~~~
---------
Just a place holder...
Subsubmenu 1
````````````
^^^^^^^^^^^^
Just a place holder...
Subsubmenu 2
````````````
^^^^^^^^^^^^
Just a place holder...
Submenu 2
~~~~~~~~~
---------
Just a place holder...
Subsubmenu 1
````````````
^^^^^^^^^^^^
Just a place holder...
Submenu 3
~~~~~~~~~
---------
Just a place holder...
Submenu 4
~~~~~~~~~
---------
Just a place holder...
Submenu 5
~~~~~~~~~
---------
Just a place holder...
Example Submenu 2
-----------------
=================
Just a place holder...
Submenu 1
~~~~~~~~~
---------
Just a place holder...
Subsubmenu 1
````````````
^^^^^^^^^^^^
Just a place holder...
Submenu 2
~~~~~~~~~
---------
Just a place holder...
Subsubmenu 1
````````````
^^^^^^^^^^^^
Just a place holder...
Submenu 3
~~~~~~~~~
---------
Just a place holder...
Submenu 4
~~~~~~~~~
---------
Just a place holder...
Submenu 5
~~~~~~~~~
---------
Just a place holder...
+134
View File
@@ -0,0 +1,134 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="2000"
height="400"
id="svg5241"
version="1.1"
inkscape:version="0.48.5 r10040"
sodipodi:docname="logo-wordmark-light.svg"
inkscape:export-filename="/Users/anthony/dev/readthedocs/guidelines/assets/logo-wordmark-light.png"
inkscape:export-xdpi="90"
inkscape:export-ydpi="90">
<defs
id="defs5243" />
<sodipodi:namedview
id="base"
pagecolor="#32322a"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="1"
inkscape:pageshadow="2"
inkscape:zoom="0.70710678"
inkscape:cx="774.9861"
inkscape:cy="86.360425"
inkscape:document-units="px"
inkscape:current-layer="text5298"
showgrid="false"
inkscape:window-width="1366"
inkscape:window-height="723"
inkscape:window-x="0"
inkscape:window-y="26"
inkscape:window-maximized="0" />
<metadata
id="metadata5246">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(0,-652.3622)">
<g
id="g5310"
transform="translate(-7.2877533,-6.3546821e-5)"
style="fill:#fafafa;fill-opacity:1">
<g
inkscape:export-ydpi="90"
inkscape:export-xdpi="90"
inkscape:export-filename="/home/anthony/secure/docs/rtd/assets/rtd-logo-2.png"
transform="matrix(0.55753644,0,0,0.55753644,62.308135,1038.8762)"
id="g3990"
style="fill:#fafafa;fill-opacity:1" />
<g
id="g3878"
transform="matrix(8.4462802,0,0,8.4462802,-93.469267,-7827.1593)"
style="fill:#fafafa;fill-opacity:1">
<g
transform="matrix(0.55753644,0,0,0.55753644,68.308135,1050.1262)"
id="g3857"
style="fill:#fafafa;fill-opacity:1">
<path
id="path3929-8"
style="font-size:medium;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-indent:0;text-align:start;text-decoration:none;line-height:normal;letter-spacing:normal;word-spacing:normal;text-transform:none;direction:ltr;block-progression:tb;writing-mode:lr-tb;text-anchor:start;baseline-shift:baseline;color:#000000;fill:#fafafa;fill-opacity:1;stroke:none;stroke-width:3.22848844999999995;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate;font-family:Sans;-inkscape-font-specification:Sans"
d="M -67.28125,-41.59375 A 1.6144056,1.6144056 0 0 0 -67.5,-38.4375 c 0,0 3.931695,1.301049 10.625,1.84375 5.374689,0.435786 11.46875,-0.375 11.46875,-0.375 a 1.6144056,1.6144056 0 1 0 -0.40625,-3.1875 c 0,0 -5.961605,0.737066 -10.8125,0.34375 C -63.013171,-40.330461 -66.5,-41.5 -66.5,-41.5 a 1.6144056,1.6144056 0 0 0 -0.78125,-0.09375 z m 0,-8 A 1.6144056,1.6144056 0 0 0 -67.5,-46.4375 c 0,0 3.931695,1.301049 10.625,1.84375 5.374689,0.435786 11.46875,-0.375 11.46875,-0.375 a 1.6144056,1.6144056 0 1 0 -0.40625,-3.1875 c 0,0 -5.961605,0.737066 -10.8125,0.34375 C -63.013171,-48.330461 -66.5,-49.5 -66.5,-49.5 a 1.6144056,1.6144056 0 0 0 -0.78125,-0.09375 z m 0,-8 A 1.6144056,1.6144056 0 0 0 -67.5,-54.4375 c 0,0 3.931695,1.301049 10.625,1.84375 5.374689,0.435786 11.46875,-0.375 11.46875,-0.375 a 1.6144056,1.6144056 0 1 0 -0.40625,-3.1875 c 0,0 -5.961605,0.737066 -10.8125,0.34375 C -63.013171,-56.330461 -66.5,-57.5 -66.5,-57.5 a 1.6144056,1.6144056 0 0 0 -0.78125,-0.09375 z m 0,-8 A 1.6144056,1.6144056 0 0 0 -67.5,-62.4375 c 0,0 3.931695,1.301049 10.625,1.84375 5.374689,0.435786 11.46875,-0.375 11.46875,-0.375 a 1.6144056,1.6144056 0 1 0 -0.40625,-3.1875 c 0,0 -5.961605,0.737066 -10.8125,0.34375 C -63.013171,-64.330461 -66.5,-65.5 -66.5,-65.5 a 1.6144056,1.6144056 0 0 0 -0.78125,-0.09375 z m -11.207892,-8.437005 c -8.407221,0.05606 -11.539425,2.645057 -11.539425,2.645057 l 0,62.7837755 c 0,0 3.05858,-2.6415165 12.905554,-2.2381255 9.846974,0.403391 11.878255,3.8552765 23.979914,4.0983855 12.101659,0.243109 15.143679,-1.86026 15.143679,-1.86026 l 0.174399,-64.0045705 c 0,0 -5.446133,1.541392 -16.044742,1.627727 -10.598609,0.08634 -13.146074,-2.696144 -22.875385,-3.022922 -0.608082,-0.02042 -1.183512,-0.0328 -1.743994,-0.02907 z m 7.034109,4.098386 c 0,0 5.094376,1.68402 14.504214,2.150925 7.953019,0.39462 15.928477,-0.784797 15.928477,-0.784797 l 0,56.883263 c 0,0 -4.036665,2.1158549 -14.12635,1.395195 -7.819331,-0.558499 -16.422608,-3.517054 -16.422608,-3.517054 l 0.116267,-56.127532 z m -4.912249,1.482394 a 1.6277275,1.6277275 0 0 1 0,3.255455 c 0,0 -2.634985,0.01353 -4.243719,0.1744 -2.701025,0.270103 -4.534383,1.249862 -4.534383,1.249862 a 1.6251955,1.6251955 0 1 1 -1.511462,-2.87759 c 0,0 2.391605,-1.26521 5.726113,-1.598661 1.926801,-0.192699 4.563451,-0.203466 4.563451,-0.203466 z m -1.569595,8.022372 c 0.899775,-0.02279 1.569595,0 1.569595,0 a 1.625,1.625 0 0 1 0,3.226388 c 0,0 -2.634985,0.01352 -4.243719,0.174399 -2.701025,0.270104 -4.534383,1.249863 -4.534383,1.249863 a 1.6251955,1.6251955 0 0 1 -1.511462,-2.87759 c 0,0 2.391605,-1.26521 5.726113,-1.598661 0.963401,-0.09635 2.094081,-0.151612 2.993856,-0.174399 z m 1.569595,7.993304 a 1.6277275,1.6277275 0 0 1 0,3.255455 c 0,0 -2.634985,-0.01554 -4.243719,0.145333 -2.701025,0.270103 -4.534383,1.249862 -4.534383,1.249862 a 1.6251952,1.6251952 0 0 1 -1.511462,-2.877589 c 0,0 2.391605,-1.265211 5.726113,-1.598661 1.926801,-0.1927 4.563451,-0.1744 4.563451,-0.1744 z"
inkscape:connector-curvature="0" />
</g>
<g
style="font-size:32px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:125%;letter-spacing:-1.99000001px;word-spacing:0px;fill:#fafafa;stroke:none;font-family:Bitter;-inkscape-font-specification:Bitter"
id="text5298">
<path
d="m 63.380232,1038.8522 0,-2.592 1.056,-0.096 c 0.618664,-0.064 0.927997,-0.3627 0.928,-0.896 l 0,-14.88 -1.824,-0.096 0,-2.72 8.736,0 c 2.474654,0 4.373319,0.4587 5.696,1.376 1.322649,0.9173 1.983982,2.4213 1.984,4.512 -1.8e-5,1.4507 -0.384018,2.6453 -1.152,3.584 -0.746683,0.9387 -1.642682,1.6213 -2.688,2.048 0.767985,0.2773 1.375985,0.928 1.824,1.952 l 2.304,5.024 1.824,0.064 0,2.72 -7.904,0 0,-2.592 0.928,-0.096 c 0.490653,-0.064 0.735986,-0.256 0.736,-0.576 -1.4e-5,-0.128 -0.04268,-0.2774 -0.128,-0.448 l -1.504,-3.2 c -0.234679,-0.5334 -0.501345,-0.9067 -0.8,-1.12 -0.277344,-0.2347 -0.682677,-0.352 -1.216,-0.352 l -2.912,0 0,5.568 2.08,0.096 0,2.72 -7.968,0 m 5.888,-11.424 2.784,0 c 2.623987,0 3.935986,-1.1733 3.936,-3.52 -1.4e-5,-1.344 -0.352014,-2.2187 -1.056,-2.624 -0.682679,-0.4053 -1.792011,-0.608 -3.328,-0.608 l -2.336,0 0,6.752"
style="fill:#fafafa;font-family:Bree Serif;-inkscape-font-specification:Bree Serif Bold"
id="path3068" />
<path
d="m 90.310094,1022.2762 c 1.599989,0 2.869321,0.3947 3.808,1.184 0.938652,0.768 1.407985,1.856 1.408,3.264 -1.5e-5,0.9387 -0.202681,1.7706 -0.608,2.496 -0.405347,0.704 -0.90668,1.2586 -1.504,1.664 -0.597345,0.4053 -1.322678,0.736 -2.176,0.992 -1.429342,0.4266 -3.040007,0.64 -4.832,0.64 0.06399,1.1306 0.415994,2.048 1.056,2.752 0.639993,0.6826 1.621325,1.024 2.944,1.024 1.322656,0 2.645321,-0.4694 3.968,-1.408 l 1.216,2.592 c -0.426681,0.384 -1.152014,0.7786 -2.176,1.184 -1.002678,0.4053 -2.154677,0.608 -3.456,0.608 -2.602673,0 -4.512005,-0.7147 -5.728,-2.144 -1.216002,-1.4507 -1.824002,-3.4347 -1.824,-5.952 -2e-6,-2.5174 0.693331,-4.6293 2.08,-6.336 1.386662,-1.7067 3.327993,-2.56 5.824,-2.56 m -1.472,7.328 c 0.789325,-0.1494 1.514657,-0.4587 2.176,-0.928 0.661322,-0.4907 0.991989,-1.0667 0.992,-1.728 -1.1e-5,-1.3013 -0.640011,-1.952 -1.92,-1.952 -1.194675,0 -2.112007,0.48 -2.752,1.44 -0.640006,0.9387 -0.992006,2.0693 -1.056,3.392 0.93866,-0.021 1.791993,-0.096 2.56,-0.224"
style="fill:#fafafa;font-family:Bree Serif;-inkscape-font-specification:Bree Serif Bold"
id="path3070" />
<path
d="m 110.8632,1023.3962 0,11.904 c -1e-5,0.3413 0.0533,0.576 0.16,0.704 0.12799,0.128 0.34132,0.2026 0.64,0.224 l 1.024,0.064 0,2.56 -5.088,0 0,-1.856 -0.096,-0.032 c -1.06668,1.536 -2.52801,2.304 -4.384,2.304 -2.176,0 -3.786669,-0.6934 -4.831999,-2.08 -1.045335,-1.3867 -1.568001,-3.2854 -1.568,-5.696 -10e-7,-2.9014 0.703998,-5.1627 2.112,-6.784 1.407999,-1.6213 3.519989,-2.432 6.335999,-2.432 1.81332,0 3.71199,0.3733 5.696,1.12 m -3.712,10.368 0,-8.288 c -0.59734,-0.2773 -1.41868,-0.416 -2.464,-0.416 -1.42934,0 -2.46401,0.576 -3.104,1.728 -0.64,1.152 -0.96,2.6773 -0.96,4.576 0,3.456 1.10933,5.184 3.328,5.184 0.93866,0 1.70666,-0.2774 2.304,-0.832 0.59732,-0.576 0.89599,-1.2267 0.896,-1.952"
style="fill:#fafafa;font-family:Bree Serif;-inkscape-font-specification:Bree Serif Bold"
id="path3072" />
<path
d="m 121.12069,1022.2762 c 0.91733,0 1.79199,0.128 2.624,0.384 l 0,-3.232 c -1e-5,-0.4693 -0.27734,-0.7253 -0.832,-0.768 l -1.376,-0.096 0,-2.528 5.952,0 0,19.456 c 0.0213,0.4906 0.28799,0.736 0.8,0.736 l 1.12,0.064 0,2.56 -5.184,0 0,-1.888 -0.096,-0.032 c -0.96001,1.5573 -2.41067,2.336 -4.352,2.336 -2.432,0 -4.13867,-0.8107 -5.12,-2.432 -0.896,-1.472 -1.344,-3.2747 -1.344,-5.408 0,-2.7734 0.68267,-4.992 2.048,-6.656 1.38666,-1.664 3.30666,-2.496 5.76,-2.496 m 2.624,11.584 0,-8.288 c -0.76801,-0.3413 -1.57867,-0.512 -2.432,-0.512 -1.40801,0 -2.44267,0.5653 -3.104,1.696 -0.64,1.1307 -0.96,2.5706 -0.96,4.32 0,3.584 1.152,5.376 3.456,5.376 0.87466,0 1.59999,-0.2454 2.176,-0.736 0.57599,-0.512 0.86399,-1.1307 0.864,-1.856"
style="fill:#fafafa;font-family:Bree Serif;-inkscape-font-specification:Bree Serif Bold"
id="path3074" />
<path
d="m 141.89219,1036.3322 c 0,0 -1.484,0.56 -2.268,0.56 -0.784,0 -1.092,-0.392 -1.092,-1.4 0,-0.448 0.056,-1.036 0.168,-1.764 l 1.204,-7.476 3.864,0 0.336,-2.1 -3.864,0 0.672,-4.088 -2.772,0.56 -0.56,3.528 -2.8,0.28 -0.308,1.82 2.772,0 -1.232,7.756 c -0.112,0.644 -0.168,1.26 -0.168,1.792 0,2.212 0.924,3.332 2.828,3.332 1.568,0 3.668,-1.288 3.668,-1.288 l -0.448,-1.512"
style="font-size:28px;font-style:italic;font-weight:normal;fill:#fafafa;font-family:Bitter;-inkscape-font-specification:Bitter Italic"
id="path3076" />
<path
d="m 150.57225,1017.2922 -5.124,0.14 -0.252,1.54 2.352,0.56 -3.08,19.32 2.66,0 0.924,-5.04 c 0,0 2.212,-7.7 5.852,-7.7 1.11999,0 1.456,0.812 1.456,1.848 0,0.392 -0.056,0.812 -0.112,1.232 l -1.596,9.66 5.124,-0.28 0.252,-1.54 -2.352,-0.42 1.26,-7.84 c 0.084,-0.588 0.14,-1.148 0.14,-1.652 0,-2.016 -0.81201,-3.388 -3.052,-3.388 -4.256,0 -6.496,5.404 -6.608,5.712 l 2.156,-12.152"
style="font-size:28px;font-style:italic;font-weight:normal;fill:#fafafa;font-family:Bitter;-inkscape-font-specification:Bitter Italic"
id="path3078" />
<path
d="m 170.69755,1035.6322 c 0,0 -2.548,1.26 -4.592,1.26 -2.1,0 -3.08,-0.924 -3.08,-2.912 0,-0.364 0.028,-0.784 0.084,-1.204 5.796,0 9.828,-2.184 9.828,-5.404 0,-2.212 -1.792,-3.64 -4.62,-3.64 -4.45199,0 -8.092,4.564 -8.092,10.36 0,3.08 1.96,5.04 5.04,5.04 3.304,0 6.272,-2.072 6.272,-2.072 l -0.84,-1.428 m -7.336,-4.816 c 0.728,-2.94 2.772,-4.984 4.816,-4.984 1.428,0 2.1,0.588 2.1,1.82 0,1.848 -2.94,3.164 -6.916,3.164"
style="font-size:28px;font-style:italic;font-weight:normal;fill:#fafafa;font-family:Bitter;-inkscape-font-specification:Bitter Italic"
id="path3080" />
<path
d="m 177.64305,1038.8522 0,-2.592 1.056,-0.096 c 0.61867,-0.064 0.928,-0.3627 0.928,-0.896 l 0,-14.88 -1.824,-0.096 0,-2.72 8.768,0 c 3.13599,0 5.57865,0.832 7.328,2.496 1.77065,1.664 2.65598,4.128 2.656,7.392 -2e-5,2.0266 -0.26668,3.7973 -0.8,5.312 -0.53335,1.4933 -1.25868,2.6666 -2.176,3.52 -1.83468,1.7066 -4.11734,2.56 -6.848,2.56 l -9.088,0 m 5.888,-18.176 0,15.104 3.264,0 c 1.83466,0 3.26399,-0.6614 4.288,-1.984 1.02399,-1.3227 1.53599,-3.2427 1.536,-5.76 -10e-6,-4.9067 -2.08001,-7.36 -6.24,-7.36 l -2.848,0"
style="fill:#fafafa;font-family:Bree Serif;-inkscape-font-specification:Bree Serif Bold"
id="path3082" />
<path
d="m 205.62659,1036.5162 c 2.32532,0 3.48798,-1.8774 3.488,-5.632 -2e-5,-1.8987 -0.26668,-3.3387 -0.8,-4.32 -0.51201,-0.9813 -1.38668,-1.472 -2.624,-1.472 -1.21601,0 -2.11201,0.4693 -2.688,1.408 -0.57601,0.9387 -0.86401,2.2186 -0.864,3.84 -1e-5,3.008 0.55466,4.896 1.664,5.664 0.49066,0.3413 1.09866,0.512 1.824,0.512 m -7.36,-5.728 c 0,-1.5787 0.23466,-2.944 0.704,-4.096 0.46933,-1.1733 1.09866,-2.0693 1.888,-2.688 1.51466,-1.152 3.18932,-1.728 5.024,-1.728 1.27999,0 2.35732,0.2133 3.232,0.64 0.89598,0.4053 1.58932,0.8853 2.08,1.44 0.51198,0.5333 0.93865,1.3227 1.28,2.368 0.36265,1.024 0.54398,2.24 0.544,3.648 -2e-5,2.944 -0.71469,5.1733 -2.144,6.688 -1.42935,1.5146 -3.26401,2.272 -5.504,2.272 -2.21868,0 -3.95734,-0.7147 -5.216,-2.144 -1.25867,-1.4507 -1.888,-3.584 -1.888,-6.4"
style="fill:#fafafa;font-family:Bree Serif;-inkscape-font-specification:Bree Serif Bold"
id="path3084" />
<path
d="m 218.42846,1030.6282 c -1e-5,1.8133 0.34133,3.2213 1.024,4.224 0.68266,1.0026 1.66399,1.504 2.944,1.504 1.30132,0 2.58132,-0.4587 3.84,-1.376 l 1.376,2.464 c -1.51468,1.2373 -3.41335,1.856 -5.696,1.856 -2.28268,0 -4.08534,-0.7147 -5.408,-2.144 -1.30134,-1.4507 -1.952,-3.584 -1.952,-6.4 0,-2.816 0.74666,-4.928 2.24,-6.336 1.51466,-1.4293 3.21066,-2.144 5.088,-2.144 1.89865,0 3.65865,0.4373 5.28,1.312 l 0,4.16 -2.944,0.224 0,-1.536 c -1e-5,-0.576 -0.21335,-0.928 -0.64,-1.056 -0.40535,-0.1493 -0.83201,-0.224 -1.28,-0.224 -2.58134,0 -3.87201,1.824 -3.872,5.472"
style="fill:#fafafa;font-family:Bree Serif;-inkscape-font-specification:Bree Serif Bold"
id="path3086" />
<path
d="m 236.74521,1025.1882 c -0.51201,-0.192 -1.13068,-0.288 -1.856,-0.288 -0.72534,0 -1.31201,0.1707 -1.76,0.512 -0.42668,0.32 -0.64001,0.7253 -0.64,1.216 -1e-5,0.4693 0.0747,0.8427 0.224,1.12 0.17066,0.256 0.42666,0.48 0.768,0.672 0.53332,0.2773 1.17332,0.5226 1.92,0.736 0.74665,0.192 1.30132,0.352 1.664,0.48 0.36265,0.1066 0.81065,0.2986 1.344,0.576 0.55465,0.2773 0.97065,0.576 1.248,0.896 0.74665,0.7893 1.11998,1.8026 1.12,3.04 -2e-5,1.6 -0.58668,2.8586 -1.76,3.776 -1.15201,0.896 -2.62401,1.344 -4.416,1.344 -2.60268,0 -4.56534,-0.3307 -5.888,-0.992 l 0,-4.448 2.88,-0.224 0,1.536 c -1e-5,0.9386 0.89599,1.408 2.688,1.408 1.79199,0 2.68799,-0.6507 2.688,-1.952 -1e-5,-0.4694 -0.16001,-0.8534 -0.48,-1.152 -0.29868,-0.2987 -0.59735,-0.5014 -0.896,-0.608 -0.29868,-0.1067 -0.66134,-0.2134 -1.088,-0.32 -0.40534,-0.1067 -0.81068,-0.2134 -1.216,-0.32 -0.38401,-0.1067 -0.81068,-0.2454 -1.28,-0.416 -0.44801,-0.192 -0.94934,-0.4587 -1.504,-0.8 -1.08801,-0.704 -1.63201,-1.8774 -1.632,-3.52 -1e-5,-1.664 0.58666,-2.944 1.76,-3.84 1.17333,-0.896 2.64532,-1.344 4.416,-1.344 1.79199,0 3.56265,0.4267 5.312,1.28 l 0,3.84 -2.88,0.224 0,-1.344 c -1e-5,-0.5333 -0.24535,-0.896 -0.736,-1.088"
style="fill:#fafafa;font-family:Bree Serif;-inkscape-font-specification:Bree Serif Bold"
id="path3088" />
</g>
</g>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

+101
View File
@@ -0,0 +1,101 @@
*******************
Structural Elements
*******************
.. contents:: Table of Contents
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec lorem neque, interdum in ipsum nec,
finibus dictum velit. Ut eu efficitur arcu, id aliquam erat. In sit amet diam gravida, imperdiet tellus eu,
gravida nisl. Praesent aliquet odio eget libero elementum, quis rhoncus tellus tincidunt.
Suspendisse quis volutpat ipsum. Sed lobortis scelerisque tristique. Aenean condimentum risus tellus,
quis accumsan ipsum laoreet ut. Integer porttitor maximus suscipit. Mauris in posuere sapien.
Aliquam accumsan feugiat ligula, nec fringilla libero commodo sed. Proin et erat pharetra.
---------
Etiam turpis ante, luctus sed velit tristique, finibus volutpat dui. Nam sagittis vel ante nec malesuada.
Praesent dignissim mi nec ornare elementum. Nunc eu augue vel sem dignissim cursus sed et nulla.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Pellentesque dictum dui sem, non placerat tortor rhoncus in. Sed placerat nulla at rhoncus iaculis.
Document Section
================
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed condimentum nulla vel neque venenatis,
nec placerat lorem placerat. Cras purus eros, gravida vitae tincidunt id, vehicula nec nulla.
Fusce aliquet auctor cursus. Phasellus ex neque, vestibulum non est vitae, viverra fringilla tortor.
Donec vestibulum convallis justo, a faucibus lorem vulputate vel. Aliquam cursus odio eu felis sodales aliquet.
Aliquam erat volutpat. Maecenas eget dictum mauris. Suspendisse arcu eros, condimentum eget risus sed,
luctus efficitur arcu. Cras ut dictum mi. Nulla congue interdum lorem, semper semper enim commodo nec.
Document Subsection
-------------------
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam efficitur in eros et blandit. Nunc maximus,
nisl at auctor vestibulum, justo ex sollicitudin ligula, id faucibus urna orci tristique nisl.
Duis auctor rutrum orci, in ornare lacus condimentum quis. Quisque arcu velit, facilisis quis interdum ac,
hendrerit auctor mauris. Curabitur urna nibh, porttitor at ante sit amet, vestibulum interdum dolor.
Duis dictum elit orci, tincidunt imperdiet sem pellentesque et. In vehicula pellentesque varius.
Phasellus a turpis sollicitudin, bibendum massa et, imperdiet neque. Integer quis sapien in magna rutrum bibendum.
Integer cursus ex sed magna vehicula finibus. Proin tempus orci quis dolor tempus, nec condimentum odio vestibulum.
Etiam efficitur sollicitudin libero, tincidunt volutpat ligula interdum sed.
Document Subsubsection
^^^^^^^^^^^^^^^^^^^^^^
Donec non rutrum lorem. Aenean sagittis metus at pharetra fringilla. Nunc sapien dolor, cursus sed nisi at,
pretium tristique lectus. Sed pellentesque leo lectus, et convallis ipsum euismod a.
Integer at leo vitae felis pretium aliquam fringilla quis odio. Sed pharetra enim accumsan feugiat pretium.
Maecenas at pharetra tortor. Morbi semper eget mi vel finibus. Cras rutrum nulla eros, id feugiat arcu pellentesque ut.
Sed finibus tortor ac nisi ultrices viverra. Duis feugiat malesuada sapien, at commodo ante porttitor ac.
Curabitur posuere mauris mi, vel ornare orci scelerisque sit amet. Suspendisse nec fringilla dui.
Document Paragraph
""""""""""""""""""
Pellentesque nec est in odio ultrices elementum. Vestibulum et hendrerit sapien, quis vulputate turpis.
Suspendisse potenti. Curabitur tristique sit amet lectus non viverra. Phasellus rutrum dapibus turpis sed imperdiet.
Mauris maximus viverra ante. Donec eu egestas mauris. Morbi vulputate tincidunt euismod. Integer vel porttitor neque.
Donec at lacus suscipit, lacinia lectus vel, sagittis lectus.
*********************
Structural Elements 2
*********************
Etiam turpis ante, luctus sed velit tristique, finibus volutpat dui. Nam sagittis vel ante nec malesuada.
Praesent dignissim mi nec ornare elementum. Nunc eu augue vel sem dignissim cursus sed et nulla.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Pellentesque dictum dui sem, non placerat tortor rhoncus in. Sed placerat nulla at rhoncus iaculis.
Document Section
================
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed condimentum nulla vel neque venenatis,
nec placerat lorem placerat. Cras purus eros, gravida vitae tincidunt id, vehicula nec nulla.
Fusce aliquet auctor cursus. Phasellus ex neque, vestibulum non est vitae, viverra fringilla tortor.
Donec vestibulum convallis justo, a faucibus lorem vulputate vel. Aliquam cursus odio eu felis sodales aliquet.
Aliquam erat volutpat. Maecenas eget dictum mauris. Suspendisse arcu eros, condimentum eget risus sed,
luctus efficitur arcu. Cras ut dictum mi. Nulla congue interdum lorem, semper semper enim commodo nec.
Document Subsection
-------------------
.. figure:: static/yi_jing_01_chien.jpg
:align: right
:figwidth: 200px
This is a caption for a figure. Text should wrap around the caption.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam efficitur in eros et blandit. Nunc maximus,
nisl at auctor vestibulum, justo ex sollicitudin ligula, id faucibus urna orci tristique nisl.
Duis auctor rutrum orci, in ornare lacus condimentum quis. Quisque arcu velit, facilisis quis interdum ac,
hendrerit auctor mauris. Curabitur urna nibh, porttitor at ante sit amet, vestibulum interdum dolor.
Duis dictum elit orci, tincidunt imperdiet sem pellentesque et. In vehicula pellentesque varius.
Phasellus a turpis sollicitudin, bibendum massa et, imperdiet neque. Integer quis sapien in magna rutrum bibendum.
Integer cursus ex sed magna vehicula finibus. Proin tempus orci quis dolor tempus, nec condimentum odio vestibulum.
Etiam efficitur sollicitudin libero, tincidunt volutpat ligula interdum sed. Praesent congue sagittis nisl et suscipit.
Vivamus sagittis risus et egestas commodo.Cras venenatis arcu in pharetra interdum.
Donec quis metus porttitor tellus cursus lobortis. Quisque et orci magna. Fusce rhoncus mi mi,
at vehicula massa rhoncus quis. Mauris augue leo, pretium eget molestie vitae, efficitur nec nulla.
In hac habitasse platea dictumst. Sed sit amet imperdiet purus.
File renamed without changes.
@@ -4,7 +4,7 @@
class Foo:
r"""Docstring for class Foo.
"""Docstring for class Foo.
This text tests for the formatting of docstrings generated from output
``sphinx.ext.autodoc``. Which contain reST, but sphinx nests it in the
@@ -103,5 +103,11 @@ class Foo:
:raises ValueError: When ``a`` is not an integer.
.. versionadded:: 1.0
This was added in 1.0
.. versionchanged:: 2.0
This was changed in 2.0
.. deprecated:: 3.0
This is deprecated since 3.0
"""
return sum(kwargs.values()) / len(kwargs), a + b
+28
View File
@@ -0,0 +1,28 @@
.. include:: ../README.rst
.. toctree::
:caption: Theme Documentation
:maxdepth: 2
installing
configuring
changelog
contributing
.. toctree::
:maxdepth: 2
:numbered:
:caption: Demo Documents
demo/structure
demo/demo
demo/lists_tables
demo/api
.. toctree::
:maxdepth: 3
:numbered:
:caption: This is an incredibly long caption for a long menu
demo/long
+32
View File
@@ -0,0 +1,32 @@
************
Installation
************
Via Python Package
==================
Install the package (or add it to your ``requirements.txt`` file):
.. code:: bash
pip install sphinx_rtd_theme
In your ``conf.py`` file:
.. code:: python
html_theme = "sphinx_rtd_theme"
Via Git or Download
===================
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:
.. code:: python
html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]
+38
View File
@@ -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
+2
View File
@@ -0,0 +1,2 @@
sphinxcontrib-httpdomain
sphinx
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
+257
View File
@@ -0,0 +1,257 @@
var jQuery = (typeof(window) != 'undefined') ? window.jQuery : require('jquery');
// Sphinx theme nav state
function ThemeNav () {
var nav = {
navBar: null,
win: null,
winScroll: false,
winResize: false,
linkScroll: false,
winPosition: 0,
winHeight: null,
docHeight: null,
isRunning: false
};
nav.enable = function (withStickyNav) {
var self = this;
// TODO this can likely be removed once the theme javascript is broken
// out from the RTD assets. This just ensures old projects that are
// calling `enable()` get the sticky menu on by default. All other cals
// to `enable` should include an argument for enabling the sticky menu.
if (typeof(withStickyNav) == 'undefined') {
withStickyNav = true;
}
if (self.isRunning) {
// Only allow enabling nav logic once
return;
}
self.isRunning = true;
jQuery(function ($) {
self.init($);
self.reset();
self.win.on('hashchange', self.reset);
if (withStickyNav) {
// Set scroll monitor
self.win.on('scroll', function () {
if (!self.linkScroll) {
if (!self.winScroll) {
self.winScroll = true;
requestAnimationFrame(function() { self.onScroll(); });
}
}
});
}
// Set resize monitor
self.win.on('resize', function () {
if (!self.winResize) {
self.winResize = true;
requestAnimationFrame(function() { self.onResize(); });
}
});
self.onResize();
});
};
// TODO remove this with a split in theme and Read the Docs JS logic as
// well, it's only here to support 0.3.0 installs of our theme.
nav.enableSticky = function() {
{%- if theme_sticky_navigation|tobool %}
this.enable(true);
{%- else %}
this.enable(false);
{%- endif %}
};
nav.init = function ($) {
var doc = $(document),
self = this;
this.navBar = $('div.wy-side-scroll:first');
this.win = $(window);
// Set up javascript UX bits
$(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='rst-versions']").toggleClass("shift");
})
// Nav menu link click operations
.on('click', ".wy-menu-vertical .current ul li a", function() {
var target = $(this);
// Close menu when you click a link.
$("[data-toggle='wy-nav-shift']").removeClass("shift");
$("[data-toggle='rst-versions']").toggleClass("shift");
// Handle dynamic display of l3 and l4 nav lists
self.toggleCurrent(target);
self.hashChange();
})
.on('click', "[data-toggle='rst-current-version']", function() {
$("[data-toggle='rst-versions']").toggleClass("shift-up");
})
// Make tables responsive
$("table.docutils:not(.field-list,.footnote,.citation)")
.wrap("<div class='wy-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>");
$("table.docutils.citation")
.wrap("<div class='wy-table-responsive citation'></div>");
// Add expand links to all parents of nested ul
$('.wy-menu-vertical ul').not('.simple').siblings('a').each(function () {
var link = $(this);
expand = $('<span class="toctree-expand"></span>');
expand.on('click', function (ev) {
self.toggleCurrent(link);
ev.stopPropagation();
return false;
});
link.prepend(expand);
});
};
nav.reset = function () {
// Get anchor from URL and open up nested nav
var anchor = encodeURI(window.location.hash) || '#';
try {
var vmenu = $('.wy-menu-vertical');
var link = vmenu.find('[href="' + anchor + '"]');
if (link.length === 0) {
// this link was not found in the sidebar.
// Find associated id element, then its closest section
// in the document and try with that one.
var id_elt = $('.document [id="' + anchor.substring(1) + '"]');
var closest_section = id_elt.closest('div.section');
link = vmenu.find('[href="#' + closest_section.attr("id") + '"]');
if (link.length === 0) {
// still not found in the sidebar. fall back to main section
link = vmenu.find('[href="#"]');
}
}
// 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');
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[0].scrollIntoView();
}
}
catch (err) {
console.log("Error expanding nav for anchor", err);
}
};
nav.onScroll = function () {
this.winScroll = false;
var newWinPosition = this.win.scrollTop(),
winBottom = newWinPosition + this.winHeight,
navPosition = this.navBar.scrollTop(),
newNavPosition = navPosition + (newWinPosition - this.winPosition);
if (newWinPosition < 0 || winBottom > this.docHeight) {
return;
}
this.navBar.scrollTop(newNavPosition);
this.winPosition = newWinPosition;
};
nav.onResize = function () {
this.winResize = false;
this.winHeight = this.win.height();
this.docHeight = $(document).height();
};
nav.hashChange = function () {
this.linkScroll = true;
this.win.one('hashchange', function () {
this.linkScroll = false;
});
};
nav.toggleCurrent = function (elem) {
var parent_li = elem.closest('li');
parent_li.siblings('li.current').removeClass('current');
parent_li.siblings().find('li.current').removeClass('current');
parent_li.find('> ul li.current').removeClass('current');
parent_li.toggleClass('current');
}
return nav;
};
module.exports.ThemeNav = ThemeNav();
if (typeof(window) != 'undefined') {
window.SphinxRtdTheme = {
Navigation: module.exports.ThemeNav,
// TODO remove this once static assets are split up between the theme
// and Read the Docs. For now, this patches 0.3.0 to be backwards
// compatible with a pre-0.3.0 layout.html
StickyNav: module.exports.ThemeNav,
};
}
// requestAnimationFrame polyfill by Erik Möller. fixes from Paul Irish and Tino Zijdel
// https://gist.github.com/paulirish/1579671
// MIT license
(function() {
var lastTime = 0;
var vendors = ['ms', 'moz', 'webkit', 'o'];
for(var x = 0; x < vendors.length && !window.requestAnimationFrame; ++x) {
window.requestAnimationFrame = window[vendors[x]+'RequestAnimationFrame'];
window.cancelAnimationFrame = window[vendors[x]+'CancelAnimationFrame']
|| window[vendors[x]+'CancelRequestAnimationFrame'];
}
if (!window.requestAnimationFrame)
window.requestAnimationFrame = function(callback, element) {
var currTime = new Date().getTime();
var timeToCall = Math.max(0, 16 - (currTime - lastTime));
var id = window.setTimeout(function() { callback(currTime + timeToCall); },
timeToCall);
lastTime = currTime + timeToCall;
return id;
};
if (!window.cancelAnimationFrame)
window.cancelAnimationFrame = function(id) {
clearTimeout(id);
};
}());
{# Do not conflict with RTD insertion of analytics script #}
{%- if not READTHEDOCS %}
{%- if theme_analytics_id %}
window.addEventListener("load", function(){
ga('create', '{{ theme_analytics_id }}', 'auto');
ga('send', 'pageview');
})
{%- endif %}
{%- endif %}
+17 -12
View File
@@ -1,18 +1,23 @@
{
"name": "sphinx_rtd_theme",
"version": "0.0.11",
"main": "js/theme.js",
"version": "0.4.3",
"private": true,
"dependencies": {},
"devDependencies": {
"grunt": "~0.4.1",
"grunt-contrib-sass": "~0.7.2",
"grunt-contrib-watch": "~0.4.3",
"grunt-contrib-connect": "0.5.0",
"grunt-contrib-clean": "0.5.0",
"grunt-contrib-copy": "0.5.0",
"connect-livereload": "~0.3.0",
"grunt-exec": "~0.4.2",
"grunt-open": "0.2.2",
"matchdep": "~0.1.2"
"bower": "^1.8.4",
"browserify": "^13.0.0",
"connect-livereload": "~0.6.0",
"grunt": "~1.0.1",
"grunt-banner": "^0.6.0",
"grunt-browserify": "^5.0.0",
"grunt-contrib-clean": "^1.0.0",
"grunt-contrib-connect": "^1.0.2",
"grunt-contrib-copy": "~1.0.0",
"grunt-contrib-sass": "~1.0.0",
"grunt-contrib-uglify": "~3.3.0",
"grunt-contrib-watch": "~1.0.0",
"grunt-exec": "~1.0.1",
"grunt-open": "0.2.3",
"matchdep": "~1.0.1"
}
}
-1
View File
@@ -1 +0,0 @@
sphinx>=1.3
+5 -6
View File
@@ -5,7 +5,6 @@
width: $nav-desktop-width
color: $section-background-color
background: darken($menu-background-color, 8%)
border-top: solid 10px $menu-background-color
font-family: $base-font-family
z-index: $z-index-tray
a
@@ -34,6 +33,10 @@
&.rst-active-old-version
background-color: $yellow
color: $black
&.shift-up
height: auto
max-height: 100%
overflow-y: scroll
&.shift-up .rst-other-versions
display: block
.rst-other-versions
@@ -62,6 +65,7 @@
left: auto
border: none
max-width: $nav-desktop-width
max-height: 90%
.icon-book
float: none
.fa-book
@@ -86,8 +90,3 @@
display: none
&.shift
display: block
img
width: 100%
height: auto
+1 -1
View File
@@ -1,6 +1,6 @@
// Slimmer version of FA for use on the badge_only.sass file.
+font-face(FontAwesome, '#{$font-awesome-dir}fontawesome_webfont')
+font-face(FontAwesome, '#{$font-awesome-dir}fontawesome-webfont')
.fa:before
display: inline-block
+9
View File
@@ -1,3 +1,6 @@
.wy-breadcrumbs
+clearfix
.wy-breadcrumbs li
display: inline-block
&.wy-breadcrumbs-aside
@@ -7,6 +10,12 @@
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
@@ -12,6 +12,8 @@
@extend .fa-github
.icon-bitbucket
@extend .fa-bitbucket
.icon-gitlab
@extend .fa-gitlab
.icon-fire
@extend .fa-fire
.icon-circle-arrow-right
+23 -17
View File
@@ -1,36 +1,42 @@
@font-face
font-family: 'Inconsolata'
font-style: normal
font-weight: 400
src: local('Inconsolata'), url(../fonts/Inconsolata.ttf) format('truetype')
@font-face
font-family: 'Inconsolata'
font-family: 'Lato'
src: url('../fonts/Lato/lato-regular.eot')
src: url('../fonts/Lato/lato-regular.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-regular.woff2') format('woff2'), url('../fonts/Lato/lato-regular.woff') format('woff'), url('../fonts/Lato/lato-regular.ttf') format('truetype')
font-weight: 400
font-style: normal
font-weight: 700
src: local('Inconsolata Bold'), local('Inconsolata-Bold'), url(../fonts/Inconsolata-Bold.ttf) format('truetype')
@font-face
font-family: 'Lato'
src: url('../fonts/Lato/lato-bold.eot')
src: url('../fonts/Lato/lato-bold.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-bold.woff2') format('woff2'), url('../fonts/Lato/lato-bold.woff') format('woff'), url('../fonts/Lato/lato-bold.ttf') format('truetype')
font-weight: 700
font-style: normal
font-weight: 400
src: local('Lato Regular'), local('Lato-Regular'), url(../fonts/Lato-Regular.ttf) format('truetype')
@font-face
font-family: 'Lato'
font-style: normal
src: url('../fonts/Lato/lato-bolditalic.eot')
src: url('../fonts/Lato/lato-bolditalic.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-bolditalic.woff2') format('woff2'), url('../fonts/Lato/lato-bolditalic.woff') format('woff'), url('../fonts/Lato/lato-bolditalic.ttf') format('truetype')
font-weight: 700
src: local('Lato Bold'), local('Lato-Bold'), url(../fonts/Lato-Bold.ttf) format('truetype')
font-style: italic
@font-face
font-family: 'Lato'
src: url('../fonts/Lato/lato-italic.eot')
src: url('../fonts/Lato/lato-italic.eot?#iefix') format('embedded-opentype'), url('../fonts/Lato/lato-italic.woff2') format('woff2'), url('../fonts/Lato/lato-italic.woff') format('woff'), url('../fonts/Lato/lato-italic.ttf') format('truetype')
font-weight: 400
font-style: italic
@font-face
font-family: 'Roboto Slab'
font-style: normal
font-weight: 400
src: local('Roboto Slab Regular'), local('RobotoSlab-Regular'), url(../fonts/RobotoSlab-Regular.ttf) format('truetype')
src: url('../fonts/RobotoSlab/roboto-slab.eot')
src: url('../fonts/RobotoSlab/roboto-slab-v7-regular.eot?#iefix') format('embedded-opentype'), url('../fonts/RobotoSlab/roboto-slab-v7-regular.woff2') format('woff2'), url('../fonts/RobotoSlab/roboto-slab-v7-regular.woff') format('woff'), url('../fonts/RobotoSlab/roboto-slab-v7-regular.ttf') format('truetype')
@font-face
@font-face
font-family: 'Roboto Slab'
font-style: normal
font-weight: 700
src: local('Roboto Slab Bold'), local('RobotoSlab-Bold'), url(../fonts/RobotoSlab-Bold.ttf) format('truetype')
src: url('../fonts/RobotoSlab/roboto-slab-v7-bold.eot')
src: url('../fonts/RobotoSlab/roboto-slab-v7-bold.eot?#iefix') format('embedded-opentype'), url('../fonts/RobotoSlab/roboto-slab-v7-bold.woff2') format('woff2'), url('../fonts/RobotoSlab/roboto-slab-v7-bold.woff') format('woff'), url('../fonts/RobotoSlab/roboto-slab-v7-bold.ttf') format('truetype')
+87 -44
View File
@@ -1,3 +1,7 @@
// Set uniform (but not relative) base font size
html
font-size: $base-font-size
.wy-affix
position: fixed
top: $gutter
@@ -24,17 +28,19 @@
padding: 0 $base-font-size
.wy-menu-vertical
width: $nav-desktop-width
header, p.caption
color: $nav-caption
height: $base-font-size * 2
display: inline-block
line-height: $base-font-size * 2
padding: 0 $gutter
margin-bottom: 0
margin: $base-line-height / 2 0 0 0
display: block
font-weight: bold
text-transform: uppercase
font-size: 80%
color: $gray
font-size: 85%
white-space: nowrap
ul
@@ -45,13 +51,13 @@
&.divide-bottom
border-bottom: solid 1px hsl(0, 0%, 25%)
&.current
background: darken($section-background-color, 10%)
background: darken($menu-vertical-background-color, 10%)
a
color: $text-medium
border-right: solid 1px darken($section-background-color, 20%)
color: $menu-link-medium
border-right: solid 1px darken($menu-vertical-background-color, 20%)
padding: $gutter / 4 $gutter * 1.5
&:hover
background: darken($section-background-color, 15%)
background: darken($menu-vertical-background-color, 15%)
code
border: none
background: inherit
@@ -67,33 +73,37 @@
@extend .fa-plus-square-o
font-size: .8em
line-height: 1.6em
color: darken($text-medium, 20%)
color: darken($menu-link-medium, 20%)
// On state for the first level
li.on a, li.current > a
color: $text-color
color: $menu-link-color
padding: $gutter / 4 $gutter
font-weight: bold
position: relative
background: $section-background-color
background: $menu-vertical-background-color
border: none
border-bottom: solid 1px darken($section-background-color, 20%)
border-top: solid 1px darken($section-background-color, 20%)
padding-left: $gutter -4px
+font-smooth
&:hover
background: $section-background-color
background: $menu-vertical-background-color
span.toctree-expand
color: $text-medium
color: $menu-link-medium
span.toctree-expand
@extend .fa
@extend .fa-minus-square-o
display: block
font-size: .8em
line-height: 1.6em
color: darken($text-medium, 30%)
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%)
// This is the on state for pages beyond second level
li.toctree-l2 a, li.toctree-l3 a, li.toctree-l4 a
color: $menu-link-color
li.toctree-l1.current li.toctree-l2, li.toctree-l2.current li.toctree-l3
> ul
display: none
@@ -102,32 +112,30 @@
li.toctree-l2
&.current
> a
background: darken($section-background-color, 20%)
background: darken($menu-vertical-background-color, 20%)
padding: $gutter / 4 $gutter * 1.5
li.toctree-l3 > a
display: block
background: darken($section-background-color, 20%)
background: darken($menu-vertical-background-color, 20%)
padding: $gutter / 4 $gutter * 2.5
a:hover span.toctree-expand
color: $text-medium
color: $menu-link-medium
span.toctree-expand
color: darken($section-background-color, 35%)
color: darken($menu-vertical-background-color, 35%)
li.toctree-l3
font-size: .9em
&.current
> a
background: darken($section-background-color, 25%)
background: darken($menu-vertical-background-color, 25%)
padding: $gutter / 4 $gutter * 2.5
li.toctree-l4 > a
display: block
background: darken($section-background-color, 25%)
background: darken($menu-vertical-background-color, 25%)
padding: $gutter / 4 $gutter * 3.5
border-top: none
border-bottom: none
a:hover span.toctree-expand
color: $text-medium
color: $menu-link-medium
span.toctree-expand
color: darken($section-background-color, 40%)
color: darken($menu-vertical-background-color, 40%)
li.toctree-l4
font-size: .9em
@@ -136,12 +144,9 @@
li ul
margin-bottom: 0
display: none
.local-toc
li ul
display: block
li ul li a
margin-bottom: 0
color: $text-light
color: $menu-link-light
font-weight: normal
a
display: inline-block
@@ -150,26 +155,30 @@
display: block
position: relative
font-size: 90%
color: $text-light
color: $menu-link-light
&:hover
background-color: lighten($menu-background-color, 10%)
cursor: pointer
span.toctree-expand
color: $text-light
color: $menu-link-light
&:active
background-color: $menu-logo-color
cursor: pointer
color: $white
color: $menu-link-active
span.toctree-expand
color: $white
color: $menu-link-active
.wy-side-nav-search
display: block
width: $nav-desktop-width
padding: $gutter / 2
margin-bottom: $gutter / 2
z-index: $z-index-popover
background-color: $link-color
background-color: $nav-search-background-color
text-align: center
padding: $gutter / 2
display: block
color: $section-background-color
color: $nav-search-color
margin-bottom: $gutter / 2
input[type=text]
width: 100%
@@ -185,7 +194,7 @@
padding: 5px
border-radius: 100%
> a, .wy-dropdown > a
color: $section-background-color
color: $nav-search-color
font-size: 100%
font-weight: bold
display: inline-block
@@ -205,6 +214,12 @@
&.icon
img.logo
margin-top: 0.85em // space it away from the title text
> div.version
margin-top: -1 * ($gutter / 4)
margin-bottom: $gutter / 2
font-weight: normal
color: rgba(255,255,255,.3)
.wy-nav .wy-menu-vertical
header
@@ -236,9 +251,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
@@ -253,11 +266,19 @@
padding-bottom: 2em
width: $nav-desktop-width
overflow-x: hidden
overflow-y: scroll
overflow-y: hidden
min-height: 100%
background: $menu-background-color
color: $menu-medium
background: $nav-background-color
z-index: $z-index-popover
.wy-side-scroll
width: $nav-desktop-width + 20px
position: relative
overflow-x: hidden
overflow-y: scroll
height: 100%
.wy-nav-top
display: none
background: $link-color
@@ -283,6 +304,7 @@
font-size: 30px
float: left
cursor: pointer
padding-top: inherit
.wy-nav-content-wrap
margin-left: $nav-desktop-width
@@ -292,7 +314,7 @@
.wy-nav-content
padding: $gutter $gutter * 2
height: 100%
max-width: 800px
max-width: $nav-content-width
margin: auto
.wy-body-mask
@@ -305,11 +327,24 @@
&.on
display: block
footer
color: $gray-light
color: $footer-color
p
margin-bottom: $base-line-height / 2
span.commit code
padding: 0px
font-family: $code-font-family
font-size: 1em
background: none
border: none
color: $footer-color
.rst-footer-buttons
&:before, &:after
width: 100%
+clearfix
.rst-breadcrumbs-buttons
margin-top: 12px
+clearfix
#search-results
@@ -328,6 +363,8 @@ footer
color: $text-medium
font-size: 90%
.genindextable li > ul
margin-left: $base-line-height
+media($tablet)
.wy-body-for-nav
@@ -342,6 +379,12 @@ footer
&.shift
width: 85%
left: 0
.wy-side-scroll
width: auto
.wy-side-nav-search
width: auto
.wy-menu.wy-menu-vertical
width: auto
.wy-nav-content-wrap
margin-left: 0
.wy-nav-content
@@ -354,7 +397,7 @@ footer
height: 100%
overflow: hidden
+media($desktop-wider)
@media screen and (min-width: $nav-media-query)
.wy-nav-content-wrap
background: rgba(0,0,0,.05)
.wy-nav-content
+156 -36
View File
@@ -17,10 +17,14 @@
// Sphinx by default applies HxW style attributes to images. This fixes that oversite.
img
max-width: 100%
height: auto !important
height: auto
div.figure
margin-bottom: $base-line-height
p.caption
font-style: italic
p:last-child.caption
margin-bottom: 0px
div.figure.align-center
text-align: center
@@ -28,13 +32,19 @@
// Usually it's a good idea to give images some space.
.section > img, .section > a > img
margin-bottom: $base-line-height
// Questionable whether this is nice or not. It styles eternal links, but comes with some baggage.
// a.reference.external:after
// font-family: FontAwesome
// content: " \f08e "
// color: $text-light
// vertical-align: super
// font-size: 60%
// normalize browser styling
abbr[title]
text-decoration: none
// Style external links
&.style-external-links a.reference.external:after
font-family: FontAwesome
content: "\f08e"
color: $text-light
vertical-align: super
font-size: 60%
margin: 0 0.2em
// 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.
@@ -42,11 +52,66 @@
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
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']
border: 1px solid $table-border-color
overflow-x: auto
// 1px hack otherwise border won't show. lame
margin: 1px 0 $base-line-height 0
div[class^='highlight']
padding: 0px
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
user-select: none
pointer-events: none
div[class^='highlight'] pre
white-space: pre
margin: 0
padding: $base-line-height / 2 $base-line-height / 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
pre.literal-block, div[class^='highlight'] pre, .linenodiv pre
font-family: $code-font-family
font-size: 12px
line-height: 1.4
.code-block-caption
font-style: italic
font-size: 85%
line-height: 1
padding: 1em 0
text-align: center
@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
.note, .attention, .caution, .danger, .error, .hint, .important, .tip, .warning, .seealso, .admonition-todo, .admonition
@extend .wy-alert
// These block elements are unsuitable for having floating objects next
// to them
clear: both;
.last
margin-bottom: 0
.admonition-title
@@ -79,8 +144,15 @@
@extend .wy-plain-list-decimal
.section ol p, .section ul p
margin-bottom: $base-line-height / 2
&:last-child
margin-bottom: $base-line-height
.line-block
margin-left: 0px
margin-bottom: $base-line-height
line-height: $base-line-height
.line-block .line-block
margin-left: $base-line-height
margin-bottom: 0px
// Generics handling of headings and toc stuff.
.topic-title
@@ -96,24 +168,29 @@
margin: 0px $base-line-height $base-line-height 0px
.align-center
margin: auto
display: block
p.caption
// Do not override display:table for tables
&:not(table)
display: block
.toctree-wrapper p.caption
@extend h2
// This is the #href that shows up on hover. Sphinx's is terrible so I hack it away.
h1, h2, h3, h4, h5, h6, dl dt, p.caption
h1, h2, h3, h4, h5, h6, dl dt, p.caption, table > caption, .code-block-caption
.headerlink
display: none
visibility: hidden
font-size: 14px
@extend .fa
&:after
visibility: visible
content: "\f0c1"
font-family: FontAwesome
display: inline-block
&:hover .headerlink
display: inline-block
&:hover .headerlink:after
visibility: visible
table > caption .headerlink:after
font-size: 12px
.centered
text-align: center
// Sidebar content. You'll see at the bottom of this file I change it in mobile.
.sidebar
@@ -122,8 +199,8 @@
display: block
margin: 0 0 $base-line-height $base-line-height
padding: $base-line-height
background: $table-stripe-color
border: solid 1px $table-border-color
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%
@@ -140,14 +217,17 @@
font-size: 100%
// Sphinx can highlight searched text with ?highlighted=searchterm
.highlighted
background: $yellow
background: $highlight-color
display: inline-block
font-weight: bold
padding: 0 $base-line-height / 4
// These are the little citation links [1] that show up within paragraphs.
.footnote-reference, .citation-reference
vertical-align: super
vertical-align: baseline
position: relative
top: -0.4em
line-height: 0
font-size: 90%
// Tables! Sphinx LOVES TABLES. Most of wyrm assumes you're only going to use a table as a table
@@ -155,7 +235,7 @@
table.docutils.citation, table.docutils.footnote
background: none
border: none
color: $gray-light
color: $text-medium
td, tr
border: none
background-color: transparent !important
@@ -164,39 +244,64 @@
padding-left: 0
padding-right: 0
vertical-align: top
code
color: $gray
// Remove the large vertical space between citations and footnotes
.wy-table-responsive.citation, .wy-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
// 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.docutils
@extend .wy-table
@extend .wy-table-bordered-all
th
border-color: $table-border-color
&:not(.field-list)
@extend .wy-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
border: none
td
border: none
padding-top: 5px
p
font-size: inherit
line-height: inherit
td > strong
display: inline-block
margin-top: 3px
.field-name
padding-right: 10px
text-align: left
white-space: nowrap
.field-body
text-align: left
padding-left: 0
// These are the "literals" that get spit out when you mark stuff as ``code`` as your write.
tt, code
@extend code
color: $black
font-family: $code-font-family
padding: 2px 5px
big, em
font-size: 100% !important
line-height: normal
.xref, a &
&.literal
color: $text-code-color
&.xref, a &
font-weight: bold
color: $text-codexref-color
pre, kbd, samp
font-family: $code-font-family
// If the literal is inside an a tag, let's color it like a link
a tt, a code
color: $link-color
@@ -204,12 +309,14 @@
margin-bottom: $base-line-height
dt
font-weight: bold
margin-bottom: $base-line-height / 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 !important
// 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
// This is what Sphinx spits out for it's autodocs. Depending upon what language the person is referencing
// these things usually have a class of "method" or "class" or something similar, but really who knows.
// Sphinx doesn't give me a generic class on these, so unfortunately I have to apply it to the root dl.
@@ -219,17 +326,17 @@
margin-bottom: $base-line-height
// This would be the equivilant of a .. class::
dt
display: inline-block
display: table
margin: $base-line-height / 4 0
font-size: 90%
line-height: normal
background: lighten($blue, 50%)
color: $blue
border-top: solid 3px lighten($blue, 20%)
background: lighten($class-color, 50%)
color: $class-color
border-top: solid 3px lighten($class-color, 20%)
padding: $base-line-height / 4
position: relative
&:before
color: lighten($blue, 20%)
color: lighten($class-color, 20%)
.headerlink
color: $text-color
font-size: 100% !important
@@ -239,9 +346,9 @@
border: none
border-left: solid 3px hsl(0,0%,80%)
background: hsl(0,0%,94%)
color: $text-medium
color: $method-color
.headerlink
color: $text-color
color: $headerlink-color
font-size: 100% !important
dt:first-child
margin-top: 0
@@ -267,7 +374,7 @@
// Doc links to sourcecode
.viewcode-link, .viewcode-back
display: inline-block
color: $green
color: $text-viewcode-color
font-size: 80%
padding-left: $base-line-height
.viewcode-back
@@ -280,16 +387,29 @@
code.download
background: inherit
padding: inherit
font-weight: normal
font-family: inherit
font-size: inherit
color: inherit
border: inherit
white-space: inherit
span:first-child
-webkit-font-smoothing: subpixel-antialiased
@extend .fa
@extend .fa-download
&:before
margin-right: 4px
.guilabel
border: 1px solid lighten($guilabel-color, 25%)
background: lighten($guilabel-color, 50%)
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
.versionmodified
font-style: italic
// Mobile specific
+media($mobile)
+57 -2
View File
@@ -2,11 +2,66 @@
// that are set in wyrm_core/wy_variables.sass. You'll find wyrm in bower_components if you're looking
// for a reference.
$font-awesome-dir: "../font/"
$font-awesome-dir: "../fonts/"
$static-img: "../img/"
$nav-content-width: 800px
$nav-media-query: (($nav-desktop-width) + ($nav-content-width))
$mathjax-color: $text-color
$headerlink-color: $text-color
// Code colors
$text-viewcode-color: $green
$text-codexref-color: $text-color
// Definition list colors
$class-color: $blue
$method-color: $gray
// 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-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: desaturate($blue, 15%)
// Sidebar colors
$sidebar-background-color: $table-stripe-color
$sidebar-border-color: $table-border-color
$sidebar-title-background-color: $table-border-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: Consolas, "Andale Mono WT", "Andale Mono", "Lucida Console", "Lucida Sans Typewriter", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace
$code-font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", Courier, monospace
-4
View File
@@ -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
Binary file not shown.

Before

Width:  |  Height:  |  Size: 153 KiB

BIN
View File
Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

+2
View File
@@ -0,0 +1,2 @@
[bdist_wheel]
universal = 1
+25 -10
View File
@@ -1,9 +1,10 @@
# -*- coding: utf-8 -*-
"""`sphinx_rtd_theme` lives on `Github`_.
.. _github: https://www.github.com/snide/sphinx_rtd_theme
.. _github: https://github.com/rtfd/sphinx_rtd_theme
"""
from io import open
from setuptools import setup
from sphinx_rtd_theme import __version__
@@ -11,12 +12,12 @@ from sphinx_rtd_theme import __version__
setup(
name='sphinx_rtd_theme',
version=__version__,
url='https://github.com/snide/sphinx_rtd_theme/',
url='https://github.com/rtfd/sphinx_rtd_theme/',
license='MIT',
author='Dave Snider',
author_email='dave.snider@gmail.com',
description='ReadTheDocs.org theme for Sphinx, 2013 version.',
long_description=open('README.rst').read(),
author='Dave Snider, Read the Docs, Inc. & contributors',
author_email='dev@readthedocs.org',
description='Read the Docs theme for Sphinx',
long_description=open('README.rst', encoding='utf-8').read(),
zip_safe=False,
packages=['sphinx_rtd_theme'],
package_data={'sphinx_rtd_theme': [
@@ -24,18 +25,32 @@ setup(
'*.html',
'static/css/*.css',
'static/js/*.js',
'static/font/*.*'
'static/fonts/*.*'
]},
include_package_data=True,
install_requires=open('requirements.txt').read().splitlines(),
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
entry_points = {
'sphinx.html_themes': [
'sphinx_rtd_theme = sphinx_rtd_theme',
]
},
install_requires=[
'sphinx'
],
classifiers=[
'Development Status :: 3 - Alpha',
'License :: OSI Approved :: BSD License',
'Framework :: Sphinx',
'Framework :: Sphinx :: Theme',
'Development Status :: 5 - Production/Stable',
'License :: OSI Approved :: MIT License',
'Environment :: Console',
'Environment :: Web Environment',
'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',
'Operating System :: OS Independent',
'Topic :: Documentation',
'Topic :: Software Development :: Documentation',
+8 -4
View File
@@ -3,15 +3,19 @@
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
"""
import os
from os import path
VERSION = (0, 1, 8)
__version__ = ".".join(str(v) for v in VERSION)
__version__ = '0.4.3.dev0'
__version_full__ = __version__
def get_html_theme_path():
"""Return list of HTML theme paths."""
cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
return cur_dir
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
def setup(app):
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
+69 -10
View File
@@ -1,23 +1,82 @@
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}
{% if page_source_suffix %}
{% set suffix = page_source_suffix %}
{% else %}
{% set suffix = source_suffix %}
{% endif %}
{% if meta is defined and meta is not none %}
{% set check_meta = True %}
{% else %}
{% set check_meta = False %}
{% endif %}
{% if check_meta and 'github_url' in meta %}
{% set display_github = True %}
{% endif %}
{% if check_meta and 'bitbucket_url' in meta %}
{% set display_bitbucket = True %}
{% endif %}
{% if check_meta and 'gitlab_url' in meta %}
{% set display_gitlab = True %}
{% endif %}
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="{{ pathto(master_doc) }}">Docs</a> &raquo;</li>
{% for doc in parents %}
{% block breadcrumbs %}
<li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> &raquo;</li>
{% for doc in parents %}
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
{% endfor %}
<li>{{ title }}</li>
{% endfor %}
<li>{{ title }}</li>
{% endblock %}
{% block breadcrumbs_aside %}
<li class="wy-breadcrumbs-aside">
{% if pagename != "search" %}
{% if display_github %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ source_suffix }}" class="fa fa-github"> Edit on GitHub</a>
{% if hasdoc(pagename) %}
{% if display_github %}
{% if check_meta and 'github_url' in meta %}
<!-- User defined GitHub URL -->
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% else %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% endif %}
{% elif display_bitbucket %}
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ source_suffix }}" class="fa fa-bitbucket"> Edit on Bitbucket</a>
{% if check_meta and 'bitbucket_url' in meta %}
<!-- User defined Bitbucket URL -->
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
{% else %}
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode|default("view") }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
{% endif %}
{% elif display_gitlab %}
{% if check_meta and 'gitlab_url' in meta %}
<!-- User defined GitLab URL -->
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
{% else %}
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
{% endif %}
{% elif show_source and source_url_prefix %}
<a href="{{ source_url_prefix }}{{ pagename }}{{ source_suffix }}">View page source</a>
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
{% elif show_source and has_source and sourcename %}
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> View page source</a>
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
{% endif %}
{% endif %}
</li>
{% endblock %}
</ul>
{% 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="breadcrumb navigation">
{% 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"></span></a>
{% endif %}
{% 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"></span> Previous</a>
{% endif %}
</div>
{% endif %}
<hr/>
</div>
+26 -8
View File
@@ -1,11 +1,11 @@
<footer>
{% if next or prev %}
{% 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 navigation">
{% 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"></span></a>
<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"></span></a>
{% endif %}
{% if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<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"></span> {{ _('Previous') }}</a>
{% endif %}
</div>
{% endif %}
@@ -16,21 +16,39 @@
<p>
{%- if show_copyright %}
{%- if hasdoc('copyright') %}
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}{% endtrans %}
{%- else %}
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}{% endtrans %}
{%- endif %}
{%- endif %}
{%- if last_updated %}
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
{%- if build_id and build_url %}
{% trans build_url=build_url, build_id=build_id %}
<span class="build">
Build
<a href="{{ build_url }}">{{ build_id }}</a>.
</span>
{% endtrans %}
{%- elif commit %}
{% trans commit=commit %}
<span class="commit">
Revision <code>{{ commit }}</code>.
</span>
{% endtrans %}
{%- elif last_updated %}
<span class="lastupdated">
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
</span>
{%- endif %}
</p>
</div>
{%- if show_sphinx %}
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
{%- endif %}
{%- block extrafooter %} {% endblock %}
</footer>
+139 -104
View File
@@ -6,10 +6,11 @@
{%- else %}
{%- set titlesuffix = "" %}
{%- endif %}
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<!--[if IE 8]><html class="no-js lt-ie9" lang="{{ lang_attr }}" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="{{ lang_attr }}" > <!--<![endif]-->
<head>
<meta charset="utf-8">
{{ metatags }}
@@ -22,159 +23,193 @@
{% if favicon %}
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
{% endif %}
{# CANONICAL URL #}
{% if theme_canonical_url %}
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
{% endif %}
{# JAVASCRIPTS #}
<script type="text/javascript" src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
{%- 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" %}
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
{%- for scriptfile in script_files %}
{{ js_tag(scriptfile) }}
{%- endfor %}
{% else %}
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'{{ url_root }}',
VERSION:'{{ release|e }}',
LANGUAGE:'{{ language }}',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }},
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
};
</script>
{%- for scriptfile in script_files %}
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{% endif %}
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
{%- if not READTHEDOCS %}
{%- if theme_analytics_id %}
<script src="https://ssl.google-analytics.com/analytics.js" async id="ga"></script>
{%- endif %}
{%- endif %}
{# OPENSEARCH #}
{%- if use_opensearch %}
<link rel="search" type="application/opensearchdescription+xml"
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
{%- endif %}
{%- endif %}
{# CSS #}
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
{%- for css in css_files %}
{%- if css|attr("rel") %}
<link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} />
{%- else %}
<link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
{%- endif %}
{%- endfor %}
{# OPENSEARCH #}
{% if not embedded %}
{% if use_opensearch %}
<link rel="search" type="application/opensearchdescription+xml" title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" href="{{ pathto('_static/opensearch.xml', 1) }}"/>
{% endif %}
{% endif %}
{# RTD hosts this file, so just load on non RTD builds #}
{% if not READTHEDOCS %}
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
{% endif %}
{% for cssfile in css_files %}
{%- for cssfile in extra_css_files %}
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{% endfor %}
{% for cssfile in extra_css_files %}
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{% endfor %}
{%- endfor %}
{%- block linktags %}
{%- if hasdoc('about') %}
<link rel="author" title="{{ _('About these documents') }}"
href="{{ pathto('about') }}"/>
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
{%- endif %}
{%- if hasdoc('genindex') %}
<link rel="index" title="{{ _('Index') }}"
href="{{ pathto('genindex') }}"/>
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
{%- endif %}
{%- if hasdoc('search') %}
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/>
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
{%- endif %}
{%- if hasdoc('copyright') %}
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"/>
{%- endif %}
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/>
{%- if parents %}
<link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/>
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
{%- endif %}
{%- if next %}
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/>
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
{%- endif %}
{%- if prev %}
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}"/>
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
{%- endif %}
{%- endblock %}
{%- block extrahead %} {% endblock %}
{# Keep modernizr in head - http://modernizr.com/docs/#installing #}
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<body class="wy-body-for-nav">
{% 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-nav-search">
{% block sidebartitle %}
<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 %}
{% 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 #}
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
{% endif %}
</a>
{% include "searchbox.html" %}
{% endblock %}
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
{% block menu %}
{% set toctree = toctree(maxdepth=4, collapse=False, includehidden=True) %}
{% if toctree %}
{{ toctree }}
{% 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
#}
<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 %}
{%- set nav_version = current_version %}
{% endif %}
{% if nav_version %}
<div class="version">
{{ nav_version }}
</div>
{% endif %}
{% endif %}
{% include "searchbox.html" %}
{% endblock %}
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
{% block menu %}
{#
The singlehtml builder doesn't handle this toctree call when the
toctree is empty. Skip building this for now.
#}
{% if 'singlehtml' not in builder %}
{% set global_toc = toctree(maxdepth=theme_navigation_depth|int,
collapse=theme_collapse_navigation|tobool,
includehidden=theme_includehidden|tobool,
titles_only=theme_titles_only|tobool) %}
{% endif %}
{% if global_toc %}
{{ global_toc }}
{% else %}
<!-- Local TOC -->
<div class="local-toc">{{ toc }}</div>
{% endif %}
{% endblock %}
{% endif %}
{% endblock %}
</div>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
{# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
<nav class="wy-nav-top" aria-label="top navigation">
{% block mobile_nav %}
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
{% endblock %}
</nav>
{# PAGE CONTENT #}
<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">
<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>
{%- endblock %}
{% include "footer.html" %}
</div>
{%- endblock %}
</div>
</section>
</div>
{% include "versions.html" %}
{% if not embedded %}
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'{{ url_root }}',
VERSION:'{{ release|e }}',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }}
};
</script>
{%- for scriptfile in script_files %}
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{% endif %}
{# RTD hosts this file, so just load on non RTD builds #}
{% if not READTHEDOCS %}
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
{% endif %}
{# STICKY NAVIGATION #}
{% if theme_sticky_navigation %}
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
{% endif %}
{%- include "versions.html" %}
{%- block footer %} {% endblock %}
</body>
-205
View File
@@ -1,205 +0,0 @@
{#
basic/layout.html
~~~~~~~~~~~~~~~~~
Master layout template for Sphinx themes.
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{%- block doctype -%}
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
{%- endblock %}
{%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
(sidebars != []) %}
{%- set url_root = pathto('', 1) %}
{# XXX necessary? #}
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
{%- if not embedded and docstitle %}
{%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
{%- else %}
{%- set titlesuffix = "" %}
{%- endif %}
{%- macro relbar() %}
<div class="related">
<h3>{{ _('Navigation') }}</h3>
<ul>
{%- for rellink in rellinks %}
<li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
{%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
{%- endfor %}
{%- block rootrellink %}
<li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
{%- endblock %}
{%- for parent in parents %}
<li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
{%- endfor %}
{%- block relbaritems %} {% endblock %}
</ul>
</div>
{%- endmacro %}
{%- macro sidebar() %}
{%- if render_sidebar %}
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
{%- block sidebarlogo %}
{%- if logo %}
<p class="logo"><a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
</a></p>
{%- endif %}
{%- endblock %}
{%- if sidebars != None %}
{#- new style sidebar: explicitly include/exclude templates #}
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
{%- else %}
{#- old style sidebars: using blocks -- should be deprecated #}
{%- block sidebartoc %}
{%- include "localtoc.html" %}
{%- endblock %}
{%- block sidebarrel %}
{%- include "relations.html" %}
{%- endblock %}
{%- block sidebarsourcelink %}
{%- include "sourcelink.html" %}
{%- endblock %}
{%- if customsidebar %}
{%- include customsidebar %}
{%- endif %}
{%- block sidebarsearch %}
{%- include "searchbox.html" %}
{%- endblock %}
{%- endif %}
</div>
</div>
{%- endif %}
{%- endmacro %}
{%- macro script() %}
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '{{ url_root }}',
VERSION: '{{ release|e }}',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }}
};
</script>
{%- for scriptfile in script_files %}
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{%- endmacro %}
{%- macro css() %}
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
{%- for cssfile in css_files %}
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{%- endfor %}
{%- endmacro %}
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" />
{{ metatags }}
{%- block htmltitle %}
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
{%- endblock %}
{{ css() }}
{%- if not embedded %}
{{ script() }}
{%- if use_opensearch %}
<link rel="search" type="application/opensearchdescription+xml"
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
{%- endif %}
{%- if favicon %}
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
{%- endif %}
{%- endif %}
{%- block linktags %}
{%- if hasdoc('about') %}
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
{%- endif %}
{%- if hasdoc('genindex') %}
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
{%- endif %}
{%- if hasdoc('search') %}
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
{%- endif %}
{%- if hasdoc('copyright') %}
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
{%- endif %}
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
{%- if parents %}
<link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
{%- endif %}
{%- if next %}
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
{%- endif %}
{%- if prev %}
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
{%- endif %}
{%- endblock %}
{%- block extrahead %} {% endblock %}
</head>
<body>
{%- block header %}{% endblock %}
{%- block relbar1 %}{{ relbar() }}{% endblock %}
{%- block content %}
{%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
<div class="document">
{%- block document %}
<div class="documentwrapper">
{%- if render_sidebar %}
<div class="bodywrapper">
{%- endif %}
<div class="body">
{% block body %} {% endblock %}
</div>
{%- if render_sidebar %}
</div>
{%- endif %}
</div>
{%- endblock %}
{%- block sidebar2 %}{{ sidebar() }}{% endblock %}
<div class="clearer"></div>
</div>
{%- endblock %}
{%- block relbar2 %}{{ relbar() }}{% endblock %}
{%- block footer %}
<div class="footer">
{%- if show_copyright %}
{%- if hasdoc('copyright') %}
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
{%- else %}
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
{%- endif %}
{%- endif %}
{%- if last_updated %}
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
{%- endif %}
{%- if show_sphinx %}
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
{%- endif %}
</div>
<p>asdf asdf asdf asdf 22</p>
{%- endblock %}
</body>
</html>
+3 -8
View File
@@ -10,15 +10,10 @@
{%- extends "layout.html" %}
{% set title = _('Search') %}
{% set script_files = script_files + ['_static/searchtools.js'] %}
{% block footer %}
<script type="text/javascript">
jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
</script>
{# this is used when loading the search index using $.ajax fails,
such as on Chrome for documents on localhost #}
<script type="text/javascript" id="searchindexloader"></script>
{%- block extrahead %}
<script type="text/javascript" src="{{ pathto('searchindex.js', 1) }}" defer></script>
{{ super() }}
{% endblock %}
{%- endblock %}
{% block body %}
<noscript>
<div id="fallback" class="admonition warning">
+1 -1
View File
@@ -1,7 +1,7 @@
{%- if builder != 'singlehtml' %}
<div role="search">
<form id="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="text" name="q" placeholder="{{ _('Search docs') }}" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
+1 -2
View File
@@ -1,2 +1 @@
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../font/fontawesome_webfont.eot");src:url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"),url("../font/fontawesome_webfont.woff") format("woff"),url("../font/fontawesome_webfont.ttf") format("truetype"),url("../font/fontawesome_webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:0.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}}
/*# sourceMappingURL=badge_only.css.map */
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
@@ -1,7 +0,0 @@
{
"version": 3,
"mappings": "CAyDA,SAAY,EACV,qBAAsB,EAAE,UAAW,EAqDrC,QAAS,EARP,IAAK,EAAE,AAAC,EACR,+BAAS,EAEP,MAAO,EAAE,IAAK,EACd,MAAO,EAAE,CAAE,EACb,cAAO,EACL,IAAK,EAAE,GAAI,EC1Gb,SAkBC,EAjBC,UAAW,ECFJ,UAAW,EDGlB,UAAW,EAHqC,KAAM,EAItD,SAAU,EAJsD,KAAM,EAapE,EAAG,EAAE,qCAAwB,EAC7B,EAAG,EAAE,0PAAyE,ECZpF,SAAU,EACR,MAAO,EAAE,WAAY,EACrB,UAAW,EAAE,UAAW,EACxB,SAAU,EAAE,KAAM,EAClB,UAAW,EAAE,KAAM,EACnB,UAAW,EAAE,AAAC,EACd,cAAe,EAAE,MAAO,EAG1B,IAAK,EACH,MAAO,EAAE,WAAY,EACrB,cAAe,EAAE,MAAO,EAIxB,KAAG,EACD,MAAO,EAAE,WAAY,EACvB,sCAAiB,EAGf,IAAK,EAAE,MAAY,EAEvB,KAAM,EACJ,cAAe,EAAE,GAAI,EACrB,UAAW,EAAE,EAAG,EAChB,UAAW,EAAE,KAAM,EAEjB,YAAG,EACD,IAAK,EAAE,IAAI,EACb,oDAAiB,EAGf,aAAc,EAAE,OAAQ,EAG9B,cAAe,EACb,MAAO,EAAE,EAAO,EAElB,gBAAiB,EACf,MAAO,EAAE,EAAO,EAElB,oBAAqB,EACnB,MAAO,EAAE,EAAO,EAElB,sBAAuB,EACrB,MAAO,EAAE,EAAO,EAElB,kBAAmB,EACjB,MAAO,EAAE,EAAO,EAElB,oBAAqB,EACnB,MAAO,EAAE,EAAO,EAElB,oBAAqB,EACnB,MAAO,EAAE,EAAO,EAElB,sBAAuB,EACrB,MAAO,EAAE,EAAO,EAElB,qBAAsB,EACpB,MAAO,EAAE,EAAO,EAElB,uBAAwB,EACtB,MAAO,EAAE,EAAO,ECnElB,YAAa,EACX,OAAQ,EAAE,IAAK,EACf,KAAM,EAAE,AAAC,EACT,GAAI,EAAE,AAAC,EACP,IAAK,EC6E+B,IAAK,ED5EzC,IAAK,ECE+B,MAAyB,EDD7D,SAAU,EAAE,MAAkC,EAC9C,SAAU,EAAE,iBAAiC,EAC7C,UAAW,EEAyB,sDAAM,EFC1C,MAAO,EC+E6B,EAAG,ED9EvC,cAAC,EACC,IAAK,ECqE6B,MAAW,EDpE7C,cAAe,EAAE,GAAI,EACvB,6BAAgB,EACd,MAAO,EAAE,GAAI,EACf,iCAAoB,EAClB,MAAO,EAAE,GAAqB,EAC9B,eAAgB,EAAE,MAAkC,EACpD,MAAO,EAAE,IAAK,EACd,SAAU,EAAE,IAAK,EACjB,QAAS,EAAE,EAAG,EACd,KAAM,EAAE,MAAO,EACf,IAAK,ECiD6B,MAAM,EJgC1C,IAAK,EAAE,AAAC,EACR,iFAAS,EAEP,MAAO,EAAE,IAAK,EACd,MAAO,EAAE,CAAE,EACb,uCAAO,EACL,IAAK,EAAE,GAAI,EGrFX,qCAAG,EACD,IAAK,EClB2B,MAAyB,EDmB3D,0CAAQ,EACN,IAAK,EAAE,GAAI,EACb,4CAAU,EACR,IAAK,EAAE,GAAI,EACb,iDAAiB,EACf,eAAgB,ECQgB,MAAI,EDPpC,IAAK,EC0B2B,GAAM,EDzBxC,wDAAwB,EACtB,eAAgB,ECXgB,MAAO,EDYvC,IAAK,ECzB2B,GAAI,ED0BxC,yCAA8B,EAC5B,MAAO,EAAE,IAAK,EAChB,gCAAmB,EACjB,QAAS,EAAE,EAAG,EACd,MAAO,EAAE,GAAqB,EAC9B,IAAK,ECE6B,GAAwB,EDD1D,MAAO,EAAE,GAAI,EACb,mCAAE,EACA,MAAO,EAAE,IAAK,EACd,KAAM,EAAE,EAAG,EACX,KAAM,EAAE,AAAC,EACT,KAAM,EAAE,KAAM,EACd,MAAO,EAAE,AAAC,EACV,SAAU,EAAE,gBAA6C,EAC3D,mCAAE,EACA,MAAO,EAAE,WAAY,EACrB,KAAM,EAAE,AAAC,EACT,qCAAC,EACC,MAAO,EAAE,WAAY,EACrB,MAAO,EAAE,EAAqB,EAC9B,IAAK,ECjDyB,MAAyB,EDkD7D,sBAAW,EACT,IAAK,EAAE,GAAI,EACX,KAAM,EAAE,GAAI,EACZ,IAAK,EAAE,GAAI,EACX,GAAI,EAAE,GAAI,EACV,KAAM,EAAE,GAAI,EACZ,QAAS,ECkByB,IAAK,EDjBvC,iCAAU,EACR,IAAK,EAAE,GAAI,EACb,+BAAQ,EACN,IAAK,EAAE,GAAI,EACb,oDAA+B,EAC7B,SAAU,EAAE,IAAK,EACjB,6DAAQ,EACN,IAAK,EAAE,GAAI,EACb,+DAAU,EACR,IAAK,EAAE,GAAI,EACf,2CAAoB,EAClB,IAAK,EAAE,GAAI,EACX,KAAM,EAAE,GAAI,EACZ,UAAW,EAAE,GAAI,EACjB,MAAO,EAAE,IAAuB,EAChC,MAAO,EAAE,IAAK,EACd,SAAU,EAAE,KAAM,EGhDpB,mCAAsB,EHmDxB,YAAa,EACX,IAAK,EAAE,EAAG,EACV,MAAO,EAAE,GAAI,EACb,kBAAO,EACL,MAAO,EAAE,IAAK,EAClB,EAAG,EACD,IAAK,EAAE,GAAI,EACX,KAAM,EAAE,GAAI",
"sources": ["../../../bower_components/wyrm/sass/wyrm_core/_mixin.sass","../../../bower_components/bourbon/dist/css3/_font-face.scss","../../../sass/_theme_badge_fa.sass","../../../sass/_theme_badge.sass","../../../bower_components/wyrm/sass/wyrm_core/_wy_variables.sass","../../../sass/_theme_variables.sass","../../../bower_components/neat/app/assets/stylesheets/grid/_media.scss"],
"names": [],
"file": "badge_only.css"
}
+5 -4
View File
@@ -1,5 +1,6 @@
*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{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:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{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{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}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="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:0.2em 0;background:#ccc;color:#000;padding:0.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{html,body,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^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,.rst-content p.caption,h3{orphans:3;widows:3}h2,.rst-content p.caption,h3{page-break-after:avoid}}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-naLine truncated
* Font Awesome 4.2.0 by @davegandy - http://fontawesome.io - @fontawesome
/* sphinx_rtd_theme version 0.4.3 | MIT license */
/* Built 20190212 16:02 */
*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{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:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,.rst-content code,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{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{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}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="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;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{html,body,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^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:.5cm}p,h2,.rst-content .toctree-wrapper p.caption,h3{orphans:3;widows:3}h2,.rst-content .toctree-wrapper p.caption,h3{page-break-after:avoid}}.fa:before,.wy-menu-vertical li span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.rst-content .admonition-title: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 dl dt .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content .code-block-caption .headerlink:before,.rst-content tt.download span:first-child:before,.rst-content code.download span:first-child:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.rst-content .admonition,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="nLine truncated
* 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?v=4.2.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.2.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff?v=4.2.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.2.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.2.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content p.caption .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon{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:0.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:0.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content p.caption .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 dl dt .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.rst-content code.download span.pull-left:first-child,.pull-left.icon{margin-right:.3em}.fa.pull-right,.wy-menu-vertical li span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content p.caption .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 dl dt .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.rst-content code.download span.pull-right:first-child,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=1);-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=3);-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=0);-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-checLine truncated
/*# sourceMappingURL=theme.css.map */
*/@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.7.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff2?v=4.7.0") format("woff2"),url("../fonts/fontawesome-webfont.woff?v=4.7.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.7.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li.current>a span.toctree-expand,.rst-content .admonition-title,.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 dl dt .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content .code-block-caption .headerlink,.rst-content tt.download span:first-child,.rst-content code.download span:first-child,.icon{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.3333333333em;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.2857142857em;text-align:center}.fa-ul{padding-left:0;margin-left:2.1428571429em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.1428571429em;width:2.1428571429em;top:.1428571429em;text-align:center}.fa-li.fa-lg{left:-1.8571428571em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left,.wy-menu-vertical li span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.rst-content .fa-pull-left.admonition-title,.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 dl dt .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.rst-content code.download span.fa-pull-left:first-child,.fa-pull-left.icon{margin-right:.3em}.fa.fa-pull-right,.wy-menu-vertical li span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.rst-content .fa-pull-right.admonition-title,.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 dl dt .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.rst-content code.download span.fa-pull-right:first-child,.fa-pull-right.icon{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.wy-menu-vertical li span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.rst-content .pull-left.admonition-title,.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 dl dt .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content .code-block-caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.rst-content code.download span.pull-left:first-child,.pull-left.icon{margin-right:.3em}.fa.pull-right,.wy-menu-vertical li span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.rst-content .pull-right.admonition-title,.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 dl dt .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content .code-block-caption .pull-right.headerlink,.rst-contentLine truncated
@@ -1,7 +0,0 @@
{
"version": 3,
"mappings": "CACE,AAAE,ECQI,iBAAoB,EDPJ,SAAU,ECY1B,cAAiB,EDZD,SAAU,EC2B1B,SAAY,ED3BI,SAAU,EEFlC,uEAAiF,EAC/E,MAAO,EAAE,IAAK,EAEhB,iBAAoB,EAClB,MAAO,EAAE,WAAY,EACrB,OAAQ,EAAE,KAAM,EAChB,IAAK,EAAE,AAAC,EAEV,oBAAqB,EACnB,MAAO,EAAE,GAAI,EAEf,OAAQ,EACN,MAAO,EAAE,GAAI,EAEf,AAAC,EDLO,iBAAoB,ECMd,SAAU,EDDhB,cAAiB,ECCX,SAAU,EDchB,SAAY,ECdN,SAAU,EAExB,GAAI,EACF,QAAS,EAAE,GAAI,EACf,uBAAwB,EAAE,GAAI,EAC9B,mBAAoB,EAAE,GAAI,EAE5B,GAAI,EACF,KAAM,EAAE,AAAC,EAEX,eAAiB,EACf,MAAO,EAAE,AAAC,EAEZ,UAAW,EACT,YAAa,EAAE,SAAU,EAE3B,OAAS,EACP,UAAW,EAAE,GAAI,EAEnB,SAAU,EACR,KAAM,EAAE,AAAC,EAEX,EAAG,EACD,SAAU,EAAE,KAAM,EAGpB,EAAG,EACD,SAAU,EAAE,GAAI,EAChB,IAAK,EAAE,GAAI,EACX,cAAe,EAAE,GAAI,EAEvB,GAAI,EACF,SAAU,EAAE,GAAI,EAChB,IAAK,EAAE,GAAI,EACX,SAAU,EAAE,KAAM,EAClB,UAAW,EAAE,GAAI,EAEnB,kDAAoB,EAClB,UAAW,EAAE,cAAS,EACtB,WAAY,EAAE,sBAAa,EAC3B,QAAS,EAAE,EAAG,EAEhB,EAAG,EACD,UAAW,EAAE,EAAG,EAElB,AAAC,EACC,KAAM,EAAE,GAAI,EAEd,eAAiB,EACf,MAAO,EAAE,CAAE,EACX,MAAO,EAAE,GAAI,EAEf,IAAK,EACH,QAAS,EAAE,EAAG,EAEhB,MAAQ,EACN,QAAS,EAAE,EAAG,EACd,UAAW,EAAE,AAAC,EACd,OAAQ,EAAE,OAAQ,EAClB,aAAc,EAAE,OAAQ,EAE1B,EAAG,EACD,EAAG,EAAE,KAAM,EAEb,EAAG,EACD,KAAM,EAAE,MAAO,EAEjB,OAAU,EACR,KAAM,EAAE,AAAC,EACT,MAAO,EAAE,AAAC,EACV,SAAU,EAAE,GAAI,EAChB,eAAgB,EAAE,GAAI,EAExB,CAAE,EACA,SAAU,EAAE,GAAI,EAElB,CAAE,EACA,KAAM,EAAE,AAAC,EAEX,EAAG,EACD,KAAM,EAAE,AAAC,EACT,qBAAsB,EAAE,MAAO,EAC/B,aAAc,EAAE,KAAM,EACtB,QAAS,EAAE,GAAI,EAEjB,aAAc,EACZ,OAAQ,EAAE,KAAM,EAElB,KAAM,EACJ,KAAM,EAAE,AAAC,EAEX,GAAI,EACF,KAAM,EAAE,AAAC,EAEX,OAAQ,EACN,KAAM,EAAE,AAAC,EACT,KAAM,EAAE,AAAC,EACT,MAAO,EAAE,AAAC,EAEZ,IAAK,EACH,KAAM,EAAE,MAAO,EAEjB,KAAM,EACJ,KAAM,EAAE,AAAC,EACT,WAAY,EAAE,GAAI,EAClB,MAAO,EAAE,AAAC,EACV,UAAW,EAAE,KAAM,EAErB,2BAA+B,EAC7B,QAAS,EAAE,GAAI,EACf,KAAM,EAAE,AAAC,EACT,aAAc,EAAE,OAAQ,EACxB,cAAe,EAAE,KAAM,EAEzB,WAAa,EACX,UAAW,EAAE,KAAM,EAErB,mEAAuE,EACrE,KAAM,EAAE,MAAO,EACf,iBAAkB,EAAE,KAAM,EAC1B,QAAS,EAAE,MAAO,EAEpB,+BAAiC,EAC/B,KAAM,EAAE,MAAO,EAEjB,yCAA2C,EACzC,SAAU,EAAE,SAAU,EACtB,MAAO,EAAE,AAAC,EACV,KAAM,EAAE,GAAI,EACZ,MAAO,EAAE,GAAI,EAEf,mBAAoB,EAClB,iBAAkB,EAAE,QAAS,EAC7B,cAAe,EAAE,UAAW,EAC5B,iBAAkB,EAAE,UAAW,EAC/B,SAAU,EAAE,UAAW,EAEzB,iGAAmG,EACjG,iBAAkB,EAAE,GAAI,EAE1B,+CAAiD,EAC/C,KAAM,EAAE,AAAC,EACT,MAAO,EAAE,AAAC,EAEZ,OAAQ,EACN,OAAQ,EAAE,GAAI,EACd,aAAc,EAAE,EAAG,EACnB,KAAM,EAAE,OAAQ,EAElB,IAAK,EACH,cAAe,EAAE,OAAQ,EACzB,aAAc,EAAE,AAAC,EAEnB,CAAE,EACA,aAAc,EAAE,EAAG,EAErB,WAAY,EACV,KAAM,EAAE,MAAO,EACf,SAAU,EAAE,GAAI,EAChB,IAAK,EAAE,GAAK,EACZ,MAAO,EAAE,MAAO,EAElB,EAAG,EACD,MAAO,EAAE,IAAK,EACd,KAAM,EAAE,AAAC,EACT,UAAW,EAAE,KAAM,EACnB,OAAQ,EAAE,KAAM,EAChB,eAAgB,EAAE,UAAW,EAC7B,gBAAiB,EAAE,QAAS,EAC5B,SAAU,EAAE,GAAI,EAChB,QAAS,EAAE,EAAG,EACd,WAAY,EAAE,AAAC,EAEjB,KAAM,EACJ,MAAO,EAAE,GAAI,EAEf,MAAO,EACL,MAAO,EAAE,cAAe,EACxB,SAAU,EAAE,KAAM,EAEpB,cAAe,EACb,KAAM,EAAE,AAAC,EACT,GAAI,EAAE,YAAa,EACnB,KAAM,EAAE,EAAG,EACX,KAAM,EAAE,GAAI,EACZ,OAAQ,EAAE,KAAM,EAChB,MAAO,EAAE,AAAC,EACV,OAAQ,EAAE,OAAQ,EAClB,IAAK,EAAE,EAAG,EAEZ,+DAAiE,EAC/D,GAAI,EAAE,GAAI,EACV,KAAM,EAAE,GAAI,EACZ,KAAM,EAAE,AAAC,EACT,OAAQ,EAAE,MAAO,EACjB,OAAQ,EAAE,KAAM,EAChB,IAAK,EAAE,GAAI,EAEb,SAAU,EACR,SAAU,EAAE,KAAM,EAEpB,QAAS,EACP,OAAQ,EAAE,OAAQ,EAEpB,QAAU,EACR,QAAS,EAAE,GAAI,EAEjB,WAAY,EACV,gBAAmB,EACjB,SAAU,EAAE,cAAe,EAC7B,AAAC,EACC,SAAU,EAAE,cAAe,EAC3B,UAAW,EAAE,cAAe,EAC5B,KAAM,EAAE,cAAe,EACvB,SAAU,EAAE,cAAe,EAC7B,UAAY,EACV,cAAe,EAAE,QAAS,EAC5B,0DAA6D,EAC3D,MAAO,EAAE,CAAE,EACb,aAAe,EACb,gBAAiB,EAAE,IAAK,EAC1B,IAAK,EACH,MAAO,EAAE,iBAAkB,EAC7B,KAAO,EACL,gBAAiB,EAAE,IAAK,EAC1B,EAAG,EACD,QAAS,EAAE,cAAe,QAE1B,KAAM,EAAE,IAAK,EAEf,6BAAS,EACP,MAAO,EAAE,AAAC,EACV,KAAM,EAAE,AAAC,EACX,2BAAM,EACJ,eAAgB,EAAE,IAAK,GChM3B,ykDAAY,EACV,qBAAsB,EAAE,UAAW,EAqDrC,QAAS,EARP,IAAK,EAAE,AAAC,EACR,+BAAS,EAEP,MAAO,EAAE,IAAK,EACd,MAAO,EAAE,CAAE,EACb,cAAO,EACL,IAAK,EAAE,GAAI;;;GC1Gf,UAUC,CATC,WAAW,CAAE,aAAa,CAC1B,GAAG,CAAE,+CAAgE,CACrE,GAAG,CAAE,sSAAmG,CAKxG,WAAW,CAAE,MAAM,CACnB,UAAU,CAAE,MAAM,CCTpB,kfAAmB,CACjB,OAAO,CAAE,YAAY,CACrB,IAAI,CAAE,uCAAuC,CAC7C,SAAS,CAAE,OAAO,CAClB,cAAc,CAAE,IAAI,CACpB,sBAAsB,CAAE,WAAW,CACnC,uBAAuB,CAAE,SAAS,CCLpC,MAAsB,CACpB,SAAS,CAAE,SAAS,CACpB,WAAW,CAAE,MAAS,CACtB,cAAc,CAAE,IAAI,CAEtB,MAAsB,CAAE,SAAS,CAAE,GAAG,CACtC,MAAsB,CAAE,SAAS,CAAE,GAAG,CACtC,MAAsB,CAAE,SAAS,CAAE,GAAG,CACtC,MAAsB,CAAE,SAAS,CAAE,GAAG,CCVtC,MAAsB,CACpB,KAAK,CAAE,SAAW,CAClB,UAAU,CAAE,MAAM,CCDpB,MAAsB,CACpB,YAAY,CAAE,CAAC,CACf,WAAW,CCIU,SAAS,CDH9B,eAAe,CAAE,IAAI,CACrB,SAAK,CAAE,QAAQ,CAAE,QAAQ,CAE3B,MAAsB,CACpB,QAAQ,CAAE,QAAQ,CAClB,IAAI,CAAE,UAAa,CACnB,KAAK,CCHgB,SAAS,CDI9B,GAAG,CAAE,SAAU,CACf,UAAU,CAAE,MAAM,CAClB,YAAuB,CACrB,IAAI,CAAE,UAA0B,CEbpC,UAA0B,CACxB,OAAO,CAAE,gBAAgB,CACzB,MAAM,CAAE,iBAA4B,CACpC,aAAa,CAAE,IAAI,CAGrB,WAAY,CAAE,KAAK,CAAE,KAAK,CAC1B,UAAW,CAAE,KAAK,CAAE,IAAI,CAGtB,kpBAAY,CAAE,YAAY,CAAE,IAAI,CAChC,kqBAAa,CAAE,WAAW,CAAE,IAAI,CCXlC,QAAwB,CACtB,iBAAiB,CAAE,0BAA0B,CACrC,SAAS,CAAE,0BAA0B,CAG/C,0BASC,CARC,EAAG,CACD,iBAAiB,CAAE,YAAY,CACvB,SAAS,CAAE,YAAY,CAEjC,IAAK,CACH,iBAAiB,CAAE,cAAc,CACzB,SAAS,CAAE,cAAc,EAIrC,kBASC,CARC,EAAG,CACD,iBAAiB,CAAE,YAAY,CACvB,SAAS,CAAE,YAAY,CAEjC,IAAK,CACH,iBAAiB,CAAE,cAAc,CACzB,SAAS,CAAE,cAAc,ECvBrC,aAA8Line truncated
"sources": ["../../../bower_components/neat/app/assets/stylesheets/grid/_grid.scss","../../../bower_components/bourbon/dist/addons/_prefixer.scss","../../../bower_components/wyrm/sass/wyrm_core/_reset.sass","../../../bower_components/wyrm/sass/wyrm_core/_mixin.sass","../../../bower_components/font-awesome/scss/_path.scss","../../../bower_components/font-awesome/scss/_core.scss","../../../bower_components/font-awesome/scss/_larger.scss","../../../bower_components/font-awesome/scss/_fixed-width.scss","../../../bower_components/font-awesome/scss/_list.scss","../../../bower_components/font-awesome/scss/_variables.scss","../../../bower_components/font-awesome/scss/_bordered-pulled.scss","../../../bower_components/font-awesome/scss/_spinning.scss","../../../bower_components/font-awesome/scss/_rotated-flipped.scss","../../../bower_components/font-awesome/scss/_mixins.scss","../../../bower_components/font-awesome/scss/_stacked.scss","../../../bower_components/font-awesome/scss/_icons.scss","../../../bower_components/wyrm/sass/wyrm_core/_font_icon_defaults.sass","../../../bower_components/wyrm/sass/wyrm_core/_wy_variables.sass","../../../bower_components/wyrm/sass/wyrm_core/_alert.sass","../../../sass/_theme_variables.sass","../../../bower_components/neat/app/assets/stylesheets/grid/_media.scss","../../../bower_components/wyrm/sass/wyrm_core/_button.sass","../../../bower_components/wyrm/sass/wyrm_core/_dropdown.sass","../../../bower_components/wyrm/sass/wyrm_core/_form.sass","../../../bower_components/neat/app/assets/stylesheets/grid/_outer-container.scss","../../../bower_components/neat/app/assets/stylesheets/settings/_grid.scss","../../../bower_components/neat/app/assets/stylesheets/grid/_span-columns.scss","../../../bower_components/wyrm/sass/wyrm_core/_neat_extra.sass","../../../bower_components/wyrm/sass/wyrm_core/_generic.sass","../../../bower_components/wyrm/sass/wyrm_core/_table.sass","../../../bower_components/wyrm/sass/wyrm_core/_type.sass","../../../bower_components/wyrm/sass/wyrm_addons/pygments/_pygments.sass","../../../bower_components/wyrm/sass/wyrm_addons/pygments/_pygments_light.sass","../../../sass/_theme_breadcrumbs.sass","../../../sass/_theme_layout.sass","../../../bower_components/neat/app/assets/stylesheets/grid/_private.scss","../../../sass/_theme_badge.sass","../../../sass/_theme_rst.sass","../../../sass/_theme_mathjax.sass","../../../sass/_theme_font_local.sass"],
"names": [],
"file": "theme.css"
}
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loaded 100 of 120 files, more files were not shown because too many files have changed in this diff. Show more