Compare commits

..
664 Commits
Author SHA1 Message Date
Anthony 1671672602 Merge pull request #1206 from readthedocs/agj/update-translations-100rc1
Update translations for 1.0.0rc1
2021-08-17 10:30:41 -06:00
Anthony Johnson 82977c4407 Do update again, with new localized strings 2021-08-17 10:03:24 -06:00
Anthony Johnson 6cec377cdf Add missing locales
Because of the additional strings, translation percentage dropped. This
bumps that percentage down a bit, but I also ran with --minimum-perc 70
to get Polish locale as well.
2021-08-17 10:01:31 -06:00
Anthony Johnson c5846e3128 Update translations for 1.0.0rc1
Also note the translation updates in changelog.
2021-08-17 10:01:31 -06:00
Anthony 9264091087 Merge pull request #1207 from readthedocs/agj/update-aria-labels
Make ARIA labels more verbose and easier to translate
2021-08-17 10:00:26 -06:00
Anthony Johnson 7a7441d13b Make ARIA labels more verbose and easier to translate
Translators pointed out how the ARIA labels weren't descriptive,
especially because the translators don't have the same context around
the strings and HTML structure.

I added some translator context, so transifex can at least describe what
the string is used for, but also updated some of the strings to be more
descriptive. I dropped "breadcrumb" because it's colloquial language
that almost certainly won't translate well.
2021-08-17 09:50:20 -06:00
Anthony a5761aeece Merge pull request #1202 from readthedocs/agj/more-fix-docutils-17
Fix spacing issue with html4 output
2021-08-16 19:18:35 -06:00
Anthony Johnson 0850ef187e Try another fix
HTML5 still had the same issue with spacing.
2021-08-16 18:35:07 -06:00
Anthony Johnson 082479c226 Fix spacing issue with html4 output
The toctree wrapper can exist outside a section on html4 output. This
resolve #1201, a bug introduced with docutils 0.17 support.
2021-08-16 18:34:39 -06:00
Anthony fb065e4f10 Merge pull request #1204 from readthedocs/agj/release-10rc1
Changes for release 1.0rc1
2021-08-16 17:04:44 -06:00
Anthony Johnson 3f75a24924 Bump2version release 2021-08-16 11:30:03 -06:00
Anthony Johnson 4c76eac561 Update changelog since last release 2021-08-16 11:28:08 -06:00
Anthony f0edcba57c Merge pull request #1199 from readthedocs/agj/fix-image-spacing-html4
Fix spacing issue with HTML4 images
2021-08-12 15:18:17 -06:00
Anthony Johnson 3e157032d9 Fix spacing issue with HTML4 images
This bug was introduced in #1185, it looks like the HTML4 selector
changed to not include directly descendents of `.section` elements.
2021-08-12 13:38:24 -06:00
Ana Costa 21fd7dbc23 Merge pull request #1185 from readthedocs/docutils0.17.1
Add support for docutils 0.17
2021-08-12 18:51:52 +01:00
Ana Costa ce74456d56 Merge branch 'master' into docutils0.17.1 2021-08-12 18:38:40 +01:00
Anthony 7500f33645 Merge pull request #1192 from readthedocs/nienn/fix-list-classifier-css
Fix #1190: Add classifier separation on html4 writer
2021-08-12 11:29:07 -06:00
Ana Costa 2ea3d2ad46 Merge branch 'master' into nienn/fix-list-classifier-css 2021-08-12 18:22:49 +01:00
Ana Costa e7d8379969 Merge branch 'nienn/fix-list-classifier-css' of https://github.com/readthedocs/sphinx_rtd_theme into nienn/fix-list-classifier-css 2021-08-12 17:34:43 +01:00
Ana Costa c7b0011693 Make selector more specific and remove duplication 2021-08-12 17:33:59 +01:00
Ana Costa e4ca578129 make-classifier-class-styles-global 2021-08-12 17:33:59 +01:00
Anthony f0e90ac9fa Merge pull request #1191 from readthedocs/Blendify/fix-math-link-icon
Fix broken math link icon
2021-08-12 10:05:39 -06:00
Anthony bd19ad5ce9 Merge branch 'master' into Blendify/fix-math-link-icon 2021-08-12 10:00:12 -06:00
Ana Costa 825cb06fbe Make selector more specific and remove duplication 2021-08-12 09:25:48 +01:00
Anthony e8fd7e81f4 Merge pull request #1195 from readthedocs/agj/1.0-alpha
Bump to 1.0alpha1
2021-08-11 18:02:36 -06:00
Ana Costa 4d82701b99 Merge branch 'master' into nienn/fix-list-classifier-css 2021-08-11 07:36:12 +01:00
Aaron Carlisle 24e0374249 Fix header links for captions in tables and figures 2021-08-10 21:50:50 -04:00
Aaron Carlisle 474f2ee131 Merge branch 'docutils0.17.1' of github.com:readthedocs/sphinx_rtd_theme into docutils0.17.1 2021-08-10 21:43:07 -04:00
Aaron Carlisle 1a8a6b3a28 Fix varying margins under headings
It seems that browsers add some special default styling to header tags :(

I found that for smaller heading tags, like h5 could give more padding then h1 tags...

To fix this, everything should now just recieve the theme standard of 24px bottom margin.
2021-08-10 21:43:03 -04:00
Aaron Carlisle e24e5029de Revert back to more restrictive css selector for images 2021-08-10 21:31:45 -04:00
Aaron Carlisle 28fa50e168 Fix some caption are not italic 2021-08-10 21:31:05 -04:00
Anthony 231afc5d6c Merge pull request #1194 from readthedocs/agj/fix-bump2version
Drop sphinx config from bump2version config
2021-08-10 16:46:57 -06:00
Anthony Johnson e026647701 Update release docs 2021-08-10 16:46:15 -06:00
Anthony Johnson b74323c2ae Add changelog automation with bump2version 2021-08-10 16:39:41 -06:00
Anthony Johnson e4bcdd8c41 Bump to 1.0alpha1
I think we talked about this and never followed through on the next few
release, not sure though. After we release a new version, I think we should be updating
the repository version to something other than the most current release.

The effect would be that the version in the repository would be an
alpha/dev release, and so would be possible to differentiate easily
between 0.5.2 release on PyPI and 0.5.3alpha1 development release from Git.
Right now, we don't follow up with incrementing this version, and so
it's harder to tell the difference. This is mostly for our use in
development.

It adds a small bit of overhead, but is nice and explicit.

This PR updates the version in the repository to 1.0.0alpha1. If we had
adopted this workflow, the progression would have been:

* Release 0.5.2, open PR bumping to 0.5.2 (run `bump2version release` and open PR)
* Follow up 0.5.2 release by bumping to `0.5.3alpha1` (run `bump2version patch` and open PR)
* We add a new feature, bump to `0.6.0alpha1` (run `bump2version minor` and open PR)
* Oops, backwards incompatible change. We bump to `1.0.0alpha1` (run `bump2version major` and open PR)
* We're ready for an rc, bump to `1.0.0rc1` (run `bump2version release` and open PR)
* Maybe we cut another rc after some fixes
* We're ready for final release, bump to `1.0.0` (run `bump2version release` and open PR)
* Follow up the release PR by bumping to the next version (run `bump2version patch` and open PR)
2021-08-10 15:37:55 -06:00
Anthony Johnson d7b0744111 Drop sphinx config from bump2version config
There is no hardcoded version in the docs now
2021-08-10 15:31:14 -06:00
Ana Costa d0713cc228 make-classifier-class-styles-global 2021-08-10 10:39:10 +01:00
Aaron Carlisle a3a890da1b Fix broken math link icon
This likely was indirectly broken with da86e4dc62

This commit addes our standard headerlink icon styles to math links aswell, before they had no styling.

Fixes #1189
2021-08-09 17:46:19 -04:00
Aaron Carlisle e555f94ae1 Support all versions less than 0.18 2021-08-09 16:50:15 -04:00
Ana Costa 5f343c996a Added missing space char in footer (#1188)
* Added missing space char in footer

* Changed space to the expected jinja syntax
2021-08-09 15:59:35 -04:00
Aaron Carlisle 34f81daaf5 Add support for docutils 0.17
This should'nt be a breaking change as backward compatibility is preserved so this change could go into 1.0 or wait until 1.1.

I know a lot of users are asking for this so it might be nice to include this in 1.0.

Fixes #1115
2021-08-06 15:07:41 -04:00
Ana Costa 9a50ff9015 Adds max-width to the logo a tag (#1183) 2021-08-04 20:01:36 -04:00
Anthony 8a02619428 Merge pull request #1178 from readthedocs/agj/docs-testing
Add docs on QA testing theme changes
2021-08-02 19:31:52 -06:00
Anthony 8448bd238e Merge branch 'master' into agj/docs-testing 2021-08-02 19:19:46 -06:00
Anthony Johnson f5b02911ae Update docs to note 1.6 as lowest version 2021-08-02 18:01:55 -07:00
Simon HausmannandAaron Carlisle 3532ffc89b Fix support for logos as urls (#1171)
* Fix support for logos as urls

Sphinx since 4.0 appears to support html_logo to also contain urls.  As
a consequence, the other themes in sphinx appear to be just using the
new logo_url variable, and in this theme that fixes support for it, too.

* Add backwards compatibility and add favicon_url

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2021-07-19 20:16:54 -04:00
Anthony Johnson 02d8fe0764 Add docs on qa testing theme changes 2021-07-19 17:57:57 -06:00
Anthony Johnson 9061c1e6de Expand tox config
* Adds support for explicit tox environments for html4/5
* Adds utility factors for py2/3, for easy access to the system python3
  binary
* Adds a noop -qa postfix factor to make it easy to compare against
  master or a tag
2021-07-19 17:57:54 -06:00
Anthony 380647d159 Merge pull request #1123 from readthedocs/Blendify/sphinx4
Add compatibility for sphinx4
2021-07-19 17:56:43 -06:00
Anthony Johnson 0207996411 Fix automerge fuck up 2021-07-19 17:45:33 -06:00
Anthony Johnson 09e2a0dc2c Merge branch 'master' into Blendify/sphinx4 2021-07-19 17:41:21 -06:00
Anthony 6417defbeb Merge pull request #1175 from readthedocs/agj/add-build-test
Add a CI test for unbuilt assets
2021-07-19 14:15:39 -06:00
Anthony Johnson 51d41e6289 Add git status path 2021-07-19 13:40:17 -06:00
Anthony Johnson c0c52f41ea Update built assets 2021-07-17 10:42:30 -06:00
Anthony Johnson 92aa3989a9 Make schema correct 2021-07-17 10:33:03 -06:00
Anthony Johnson 21b5ed45d4 Try job dependency 2021-07-17 10:30:06 -06:00
Anthony Johnson bd6a34135f Fix typo in config 2021-07-17 10:22:51 -06:00
Aaron Carlisle 047169a972 Restore highlighted code lines span full width 2021-07-17 11:26:51 -04:00
Aaron Carlisle 8d93cdea10 Italize keywords 2021-07-17 11:13:35 -04:00
Anthony Johnson e9fda1a5c1 How does sh work? 2021-07-15 12:32:23 -06:00
Anthony Johnson 1b38126245 Drop orb, fork code to apply more descriptive error 2021-07-15 12:27:47 -06:00
Aaron Carlisle 0073409aaa Merge branch 'master' into agj/add-build-test 2021-07-15 08:49:08 -04:00
Anthony Johnson e6bd3f0fc5 Don't use extension to add sphinx_version_info tuple to build context 2021-07-14 19:39:16 -06:00
Anthony Johnson ee32a53ae2 Add a CI test for unbuilt assets
Many of our PRs have out of date assets, making it hard to test the
latest changes. This will at least throw an error on the PR when build
assets aren't updated.
2021-07-14 18:24:14 -06:00
Anthony Johnson c1aa1b2c6b Rebuild assets 2021-07-14 18:23:36 -06:00
Anthony Johnson b85d3616dd Add a CI test for unbuilt assets
Many of our PRs have out of date assets, making it hard to test the
latest changes. This will at least throw an error on the PR when build
assets aren't updated.
2021-07-14 17:38:48 -06:00
Aaron Carlisle 796e78bdf7 Make font usage conistent with sphinx<4.0
This fixes the different spacing issues that were noted.
2021-07-14 16:48:17 -04:00
Anthony Johnson 6597b25257 Fix styles on code block line numbers on Sphinx 4+ 2021-07-14 00:18:33 -06:00
Anthony Johnson 6f9501293b Fix tests, missing theme extension 2021-07-13 22:45:43 -06:00
Aaron Carlisle 037890d1d1 Merge branch 'Blendify/sphinx4' of github.com:readthedocs/sphinx_rtd_theme into Blendify/sphinx4 2021-07-13 21:04:18 -04:00
Aaron Carlisle da20decbbb Compare sphinx version using a tuple 2021-07-13 21:04:16 -04:00
Aaron Carlisle d93528ef3e Tests: Add missing sphinx version 2021-07-13 19:47:25 -04:00
Aaron Carlisle e1716574e9 Merge branch 'master' into Blendify/sphinx4 2021-07-13 19:44:47 -04:00
Aaron Carlisle 2ab605a455 Tests: Fix deprecation warning with new sphinx versions (#1105)
* Tests: Fix deprecation warning with new sphinx versions

These builders where split in sphinx and the old import path will be removed in the upcoming Sphinx 4 release.

This patch requires sphinx 2 so this will be committed into the v2 release.

* Fix imports

* Use try/except for backwards compatibility
2021-07-13 05:16:47 -04:00
Aaron Carlisle 0ef60e7841 Tests: run against sphinx 4.1 2021-07-12 20:49:30 -04:00
Aaron Carlisle 15d91096b1 Fix api docs css for sphinx4 2021-07-12 20:27:15 -04:00
Aaron Carlisle 1f45c113b6 Fix user-select line numbers class name 2021-07-12 18:57:53 -04:00
Aaron Carlisle b47f8b343b Merge branch 'master' into Blendify/sphinx4 2021-07-12 18:36:08 -04:00
Aaron CarlisleandAnthony e94984caec Make sphinx version comparison constistent
Co-authored-by: Anthony <aj@ohess.org>
2021-07-12 18:36:03 -04:00
Juan Luis Cano Rodríguez bc6e9f0766 Merge pull request #1093 from readthedocs/Blendify/python-compat
Add python version requirements to setup.py
2021-06-23 07:32:21 +02:00
Aaron Carlisle 09e9e1004c Merge branch 'master' into Blendify/sphinx4 2021-06-22 18:50:15 -04:00
Aaron Carlisle b2323ce07f Merge branch 'master' into Blendify/python-compat 2021-06-22 18:47:00 -04:00
Joe Nelson 71d6d182cf Maintain aria-expanded along with .current in menu (#1151)
Use jquery setter chaining for speed
2021-06-22 17:46:45 -04:00
ThomasTNOandAaron Carlisle ef9a0584ef Added support for gtag (#1129)
* Added support for gtag

* Fix missing curly braces

* Simplify gtag script import

* Fix tag

* Add gtag to docs

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2021-06-18 13:59:46 -04:00
Joe NelsonandAaron Carlisle a2997e8888 Allow keyboard to toggle menu expansion (#1167)
Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2021-06-18 10:16:05 -04:00
Joe Nelson da86e4dc62 Allow keyboard to activate permalink (#1162)
* Allow keyboard to activate permalink

* Change permalink icon with Blendify's suggestion

* Set permalink icon properly across Sphinx versions

* Match prior style better
2021-06-18 09:57:56 -04:00
Benjamin Balder BachandAaron Carlisle 05807985d6 Simplify example but add clarity. (#1144)
Some people might add the example code to the top of the file, in which case `alabaster` will overwrite later. Also, localization is important but not so important for people using this for the first time. My concern is that many people end up with Alabaster on RTD deployments after Sphinx 4 made it the default.

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2021-06-10 17:26:13 -04:00
Aaron Carlisle bd9010f14d Update layout.html 2021-06-09 20:26:36 -04:00
Joe Nelson 392daf5047 Show keyboard focus on buttons (#1161) 2021-06-09 20:22:07 -04:00
Anders Kaseorg 671703c3fb Remove discouraged type="text/javascript" from scripts (#1140)
type="text/javascript" is unnecessary and even discouraged by the
specification: “Authors should omit the type attribute instead of
redundantly setting it.”

https://html.spec.whatwg.org/multipage/scripting.html#attr-script-type

It causes the validator to raise warnings, too.

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2021-04-30 21:50:03 -04:00
Erik Moqvist 2026bb61dd Make mobile top navigation bar have the same background color as the side navigation header. (#1132) 2021-04-18 18:08:16 -04:00
Aaron Carlisle b73b67eb33 Revert "Test with official beta"
This reverts commit db302055b9.
2021-04-12 19:34:18 -04:00
Aaron Carlisle db302055b9 Test with official beta 2021-04-12 19:09:41 -04:00
Aaron Carlisle 836467e4b9 Add compatibility for sphinx4
Sphinx 4.x moves javascript and css declarations to `script_files` and `css_files`. This patch fixes duplicatd link and script tags when using sphinx4

Sphinx 4.x changes the default setting of html_codeblock_linenos_style to 'inline' and deprecates `html_codeblock_linenos_style`. The css for `.hll` to make the hightling span the full line cause the line number and code to be split on seperate lines. I could not get the highlight to span the full line so it was removed completely. I also made line numbers not selectible by the user.

This changes also adds the needed changes to the tox testing enviorment alhough, sphinx4 is not officially released to pypi yet. You will need to test these changes locally using: `pip install git+https://github.com/sphinx-doc/sphinx@master`
2021-04-10 16:50:34 -04:00
Aaron Carlisle 3db4e2fbfe Cleanup: Sass formatting (#1119)
* Cleanup: Sass formatting

This patch addresses some sass formatting to make the code easier to read:

- Use leading zeros on decimals less than 1
- Use parentheses around math for css propeties with multiply arguments
- Spaces after commas in arguments

In the future it would be nice to automatically format this with a tool like style lint.

* Revert Extra Tabbing

* Add back missing line

* Add whitespace back

* Fix whitespace 2
2021-04-08 23:31:36 -04:00
Aaron Carlisle 2f12da38c6 Add Missing version bumps for 0.5.2 (#1120)
Found while looking into #1117
2021-04-08 20:40:33 -04:00
Aaron Carlisle 60a094bb13 Merge branch 'master' into Blendify/python-compat 2021-04-08 17:19:58 -04:00
Santos Gallegos 9df65f15c5 Fix backport of requirements (#1118)
This was fixed before releasing 0.5.2,
but looks like the change was lost after merging it to master.
2021-04-06 18:06:31 -05:00
Eric HolscherandAaron Carlisle ca2719b32f Merge Release 0.5.2 Changelog into master (#1114)
* Setup: Require docutils<0.17'

Docutils 0.17 changes some rendering of properties, until support is added we should probably pin to use an older version.

I may not be a bad idea to keep a pinned version in the theme to prevent this issue in the future.

* Release 0.5.2

Include a changelog and bump versions

* Fix changelog

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2021-04-05 13:14:49 -04:00
Aaron Carlisle aa28eecc3a Docs: Fix intersphinx_mapping (#1110)
Sphinx documentation has moved from https://www.sphinx-doc.org/en/stable/ to https://www.sphinx-doc.org/en/master/

Fixes the command line message:
```
intersphinx inventory has moved: https://www.sphinx-doc.org/en/stable/objects.inv -> https://www.sphinx-doc.org/en/master/objects.inv
```
2021-04-02 12:21:54 -04:00
Aaron Carlisle bba36677de Merge branch 'master' into Blendify/python-compat 2021-03-31 22:09:45 -04:00
Aaron Carlisle c984d08dae Cleanup: Use page_source_suffix (#1104)
Use `page_source_suffix` instead of checking `source_suffix`

Since we now require sphinx 1.6 we can cleanup this old workaround for old sphinx versions.
2021-03-30 12:42:04 -04:00
Aaron Carlisle fe934ec0d4 Merge branch 'master' into Blendify/python-compat 2021-03-29 22:08:21 -04:00
Aaron Carlisle 7417ff92bd Update Changelog for v1.0 (#1103)
This includes all major affecting changes that have already been committed to master since the last release.
2021-03-29 19:08:22 -04:00
Aaron Carlisle 65723affd8 Merge branch 'master' into Blendify/python-compat 2021-03-29 17:15:34 -04:00
Aaron CarlisleandSantos Gallegos 3693d4c325 Add deprecation warning for dropping Sphinx 2 and Python 2 support (#1099)
* Add deprecation warning for dropping Sphinx 2 and Python 2 support

Fixes #1092

* Cleanup version imports

* Update __init__.py

* Update sphinx_rtd_theme/__init__.py

Co-authored-by: Santos Gallegos <santos_g@outlook.com>

Co-authored-by: Santos Gallegos <santos_g@outlook.com>
2021-03-29 15:57:14 -04:00
Aaron Carlisle 6f684828ed npm: Update dependencies (simple) (#1096)
This simply runs `npm update` so there are no breaking changes.
2021-03-22 13:26:56 -04:00
Aaron Carlisle 4d196ce134 Add python version requirements to setup.py
This is need in the future so we can gracefully remove python 2.7 support.
See #1075.
2021-03-17 18:29:02 -04:00
Aaron Carlisle 114fb85b44 Require Sphinx 1.6 deprecate html4 (#1091)
Sphinx 1.6 is required for de76c03824 we also do not test against versions lower than 1.6 so we should safely drop it.

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

Fixes #893
2021-03-15 13:51:06 -05:00
Santos Gallegos f8e71bf312 Don't require npm to build from source (#1039) 2021-03-15 10:12:50 -05:00
Aaron Carlisle 85f23c9edc Docs: Add text before config api type information (#1090)
* Docs: Add text before config api type information

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

This matches usual sphinx autodoc behavior.

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

This fixes these warnings when running `npm install`:

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

* 0.5.2

* Revert version bump

* Revert version bump
2021-03-12 18:12:31 -05:00
Aaron Carlisle ba1cbb1c07 Docs: Always use local theme (#1083)
This changes non PR builds on rtd to use the local theme and not the old 0.4.3 theme. We want our docs to show what the theme looks like based on the current release, not an old version.
2021-03-12 15:17:35 -05:00
Aaron Carlisle b35637651b Tests: Remove test for sphinx version no longer supported (#1071)
We no longer run tests against sphinx 1.4 so this can be removed.
2021-03-11 10:01:14 -05:00
Aaron Carlisle de76c03824 Revert "Fix problem triggered by unconditional toctree call and empty toctree" (#507)
Fixes #374
2021-03-11 09:59:21 -05:00
Aaron Carlisle 894aef556e Cleanup: Use Proper Sass Syntax (#1069)
Sass does not use semicolons at the end of lines. Also remove dead code.
2021-03-04 09:38:29 -05:00
Aaron Carlisle 4ad33d0197 Nav: Fix right padding on level2+ (#1068)
The sets the right padding the same as the first level.
The current padding is too large and varies between toc levels.
Now, the right padding is the same between all levels and only the left padding changes
2021-03-04 09:34:28 -05:00
Aaron Carlisle e001cca56f Fix Nav Buttons Size (#1067)
Currently, Nav buttons to expand the menu are a bit small and do not match the link text.
This makes the font size and line-height match between the text and icon.
2021-03-03 20:17:05 -05:00
Aaron Carlisle 8ba9c8ac0b Templates: Cleanup Whitespace (#1060)
While not perfect this cuts it down a lot and makes the html output much 
cleaner
2021-03-01 10:09:03 -05:00
Aaron Carlisle 331ba4e93c Update issue templates (#1062)
* Update issue templates

Updates the issue templates to the new GitHub versions

* Delete ISSUE_TEMPLATE.md
2021-03-01 09:39:40 -05:00
Santos Gallegos d91d7e13b3 Fix: wrap inline literals (#1050)
This preservers white spaces as is when copying,
so all good.

Fixes https://github.com/readthedocs/sphinx_rtd_theme/issues/321
2021-02-23 13:43:10 -05:00
Tobias Bengfort c8ef0fc94f Fix aria label (#1056)
* Do not use the landmark role as part of the label

See https://www.w3.org/TR/wai-aria-practices/#general-principles-of-landmark-design

* translate aria-labels
2021-02-23 12:20:37 -05:00
Santos Gallegos 3ed52c4df5 Don't toggle terminal nodes (#1049)
Terminal nodes that are already selected shouldn't be toggled.

Fix https://github.com/readthedocs/sphinx_rtd_theme/issues/1044
2021-02-11 18:24:12 -05:00
Santos Gallegos 6d89d9dbdf Test with more sphinx versions (#1047) 2021-02-11 18:09:47 -05:00
Santos Gallegos 835b20c926 Respect tab order for prev/next buttons (#1051)
This doesn't affect the display, it looks like before,
but now the tab is order is correct.
2021-02-11 16:02:54 -05:00
Santos Gallegos 60e1c21211 Update intersphinx urls (#1048) 2021-02-10 20:13:53 -05:00
Santos Gallegos 5d0a396bf9 Docs: fix typo (#1036) 2021-01-11 21:01:54 -05:00
Santos Gallegos f6554bfcbf Release 0.5.1 (#1032) 2021-01-04 17:13:31 -05:00
Eric Holscher 8871d03f1f Update translations 2021-01-04 13:48:49 -08:00
Richard Darst 1f7bdc1c36 sphinx_rtd_theme/layout: Set url_root properly on index, don't use '#' (#1025)
- You can see a practical demonstration of the problem, fully seeing
  the effect if it is not fixed, here (though that example uses the
  alabaster theme, the effect is the same here):
  https://github.com/executablebooks/sphinx-copybutton/issues/110
- This is a copy of a fix from Sphinx.  The sphinx pull request is
  https://github.com/sphinx-doc/sphinx/pull/8524

Detailed description:

- url_root is set to `#` on the index page, which layout.html tries to
  change back to `''` (the empty string).
- But, this updated url_root wasn't used in the actual location, as an
  argument to `documentation_options.js`.
- Thus, clever enough templates, which tried to use
  `$DOCUMENTATION_OPTIONS.URL_ROOT` inside javascript would fail.
  This was manifested as broken links, which led to this issue:
  https://github.com/executablebooks/sphinx-copybutton/issues/110
- I have eventually traced that back to sphinx itself, and found that
  layout.html tried to fix the problem, but the fixed value wasn't
  used.
- This fix works in my basic test, but I will continue with more tests.
- Review:
  - someone more clever should examine this and make sure it makes
    sense
  - This does not have tests.  Should it?
2020-12-15 09:24:54 -05:00
Aaron Carlisle e93295cb92 Templates: Add block for footer content info (#896)
Allows users to expand this area to add their own content
2020-12-03 18:39:12 -05:00
Santos Gallegos c27ac2944b Use canonical URL from html_baseurl (#1003)
This is in sphinx itself now https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl,
https://github.com/sphinx-doc/sphinx/blob/e886cc21710e23bc53af83d011131828b1020848/sphinx/themes/basic/layout.html#L135-L137
2020-12-03 17:15:40 -05:00
Aaron Carlisle 24f8e31c5b html search: Do not load language_data.js in non-search pages (#1021)
This is needed with changes in sphinx 3.4.x.

See https://github.com/sphinx-doc/sphinx/commit/f5289bb69993d2b1f83a509f56e418fcd5d00b87
2020-12-02 11:00:03 -05:00
Aaron Carlisle 562bc2a35d Cleanup: Make Copyright template match sphinx's basic (#933)
This matches https://github.com/sphinx-doc/sphinx/blob/3.x/sphinx/themes/basic/layout.html
2020-11-30 12:56:05 -05:00
David FischerandAaron Carlisle 24ceb6d93d Hide the search box on any "singlehtml" like builder (#975)
- This applies to the RTD builders readthedocssinglehtml
  and readthedocssinglehtmllocalmedia

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2020-11-28 01:59:59 -05:00
Santos Gallegos e2b10425ef CI: switch to circleci (#1020) 2020-11-25 18:51:19 -05:00
Santos Gallegos 38752d455f Fix vcs_pageview_mode (#1010)
Fixes https://github.com/readthedocs/sphinx_rtd_theme/issues/701
2020-11-25 17:39:51 -05:00
e2b60d7e7b Add analytics_anonymize_ip option to theme (#889)
* Add analytics_anonymize_ip option to theme

* Fix typo and use tobool filter

Co-Authored-By: Jesse Tan <jessetan@users.noreply.github.com>

* Simplify analytics_anonymize_ip description

* Update changelog.rst

Co-authored-by: Jesse Tan <jessetan@users.noreply.github.com>
Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2020-10-08 19:28:19 -04:00
Santos Gallegos 4366e9e3f8 Merge pull request #1012 from readthedocs/test-more
Test with more versions of sphinx/python
2020-10-08 17:57:23 -05:00
Santos Gallegos 33a9df7185 Tests with more versions of sphinx/python 2020-10-08 17:46:26 -05:00
Santos Gallegos f8ce9db72a Merge pull request #1005 from readthedocs/include-preinstall
Packaging: include bin/preinstall.js
2020-10-08 17:19:28 -05:00
Santos Gallegos 9d451fb079 Merge branch 'master' into include-preinstall 2020-10-08 17:11:39 -05:00
Santos Gallegos 80cc791120 Merge pull request #1011 from readthedocs/link-license
Link to sphinx license
2020-10-08 17:11:26 -05:00
Santos Gallegos cf6da7632d Link to sphinx license
Closes https://github.com/readthedocs/sphinx_rtd_theme/issues/283
2020-10-08 17:02:21 -05:00
Santos Gallegos 3d2453b3fd Merge branch 'master' into include-preinstall 2020-10-08 13:47:13 -05:00
Santos Gallegos b5cafe8e44 Merge pull request #1007 from readthedocs/mark-icons
Make nex/prev icons as aria-hidden
2020-10-08 13:46:41 -05:00
Santos Gallegos ca9a8e256e Merge branch 'master' into mark-icons 2020-10-08 13:41:57 -05:00
Santos Gallegos 1485644386 Merge pull request #1006 from readthedocs/use-well-formed-xml
Use well-formed XML syntax
2020-10-08 09:47:40 -05:00
Santos Gallegos 939584e54f Make nex/prev icons as aria-hidden
Fixes https://github.com/readthedocs/sphinx_rtd_theme/issues/954
2020-10-07 17:29:50 -05:00
Santos Gallegos f6c4e9cb62 Use well-formed XML syntax
Fixes https://github.com/readthedocs/sphinx_rtd_theme/issues/985

ref https://github.com/sphinx-doc/sphinx/commit/267eeabc008ce7ab1a0034cc9c7ce2eafc52514b
2020-10-07 16:42:21 -05:00
Santos Gallegos 58f07c0be0 Packaging: include bin/preinstall.js
Closes https://github.com/readthedocs/sphinx_rtd_theme/issues/990
2020-10-07 16:29:11 -05:00
Santos Gallegos 006cd2162a Merge pull request #1002 from benjaoming/patch-1
Use just python3 in .readthedocs.yml
2020-10-07 10:05:03 -05:00
Benjamin Balder Bach 79fd7487f0 Use latest python3 on build server
Tested this to work on a local RTD server with Python 3.7. Consider this as a better default than pinning specific Python 3 versions, which makes it harder for the central RTD server to get rid of these versions.
2020-10-07 16:45:41 +02:00
Santos Gallegos 00f402f8e9 Merge pull request #1001 from sylvestre/patch-1
Update the url to the "readthedocs" one
2020-09-30 09:16:44 -05:00
Sylvestre Ledru 6c943265c1 Update the url to the "readthedocs" one
To avoid a redirect
2020-09-30 16:11:14 +02:00
Anthony 1d85625667 Merge pull request #897 from mgeier/commit-and-date
Footer: show both "commit" and "last_updated" (if available)
2020-07-23 15:27:52 -06:00
Matthias Geier d5ed3d0ba1 Footer: show both "commit" and "last_updated" (if available)
Closes #238.
2020-07-07 17:37:33 +02:00
Anders Kaseorg 7df2524941 Revert "Add more localized strings" (#961)
The alt attribute is only valid on the <area>, <img>, and <input>
elements, not <a>.

https://html.spec.whatwg.org/multipage/indices.html#attributes-3:attr-area-alt

This reverts commit 8f327360a5 (#806).

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2020-06-26 19:53:42 -04:00
Santos Gallegos fd83875eef Merge pull request #935 from readthedocs/search-hide-edit-links
Search page: don't show "edit on" links
2020-06-22 15:00:09 -05:00
Santos Gallegos ecc58ad802 Merge branch 'master' into search-hide-edit-links 2020-06-22 14:34:33 -05:00
Nikita Titov aa71fd6cde fix broken link in footer (#947) 2020-06-19 17:06:49 -04:00
Anthony Johnson 38c30bf8ac Merge branch 'release/0.5.0' 2020-06-17 09:58:25 -06:00
Anthony Johnson a452102fff Bump version 2020-06-17 09:55:10 -06:00
Anthony Johnson b9e8328695 Update changelog for 0.5.0 2020-06-17 09:46:01 -06:00
Anthony 1a32899ba3 Merge pull request #945 from readthedocs/agj/nested-list-item-bottom-margin
Add a bottom margin for anything that does not match p, ul, ol
2020-06-17 09:41:08 -06:00
Anthony Johnson ac20ce75d4 Use only-child to limit margins on single paragraph list items
This is a compromise between the docutils intended style and more
consistent margins than 0.4.3.
2020-06-16 16:30:26 -06:00
Anthony Johnson aa0a108543 Add complex list margins, use margin-less items for ul.simple margins
0.5.0 was moving in the direction of treating everything like a simple
list. 0.4.3 had some bugs that made complex lists look closer to the
spacing that complex lists use. This resolves both and adds specific
item margins for both cases.

See https://docutils.sourceforge.io/sandbox/html4strict/data/simple-lists.html
2020-06-16 13:54:47 -06:00
Anthony Johnson d85f8f8927 Add a bottom margin for anything that does not match p, ul, ol
All other elements should maybe have a bottom margin, but paragraphs and
nested lists should not have a bottom margin.
2020-06-09 12:39:17 -06:00
Anthony Johnson 73fe2fba49 Add changelog dates 2020-06-05 10:07:16 -06:00
Anthony Johnson 4de3f217a9 No, update changelog 2020-06-05 10:05:41 -06:00
Anthony Johnson a7e656a8cf Update changelog 2020-06-05 10:04:54 -06:00
Anthony 9e1246e6ad Merge pull request #939 from readthedocs/agj/last-child-spacing-issues
Fix a number of issues around margins on last children
2020-06-05 09:55:42 -06:00
Anthony Johnson 6f0de13baf Fix a number of issues around margins on last children
The HTML4 writer depended on the `.last` selector, a class added by
Sphinx directly on output. Both writers are not using that method
anymore and instead relying on well supported CSS selectors.

This actually also addresses a number of inconsistencies with margin
spacing in lists. Version 0.4.3 and prior have a number of odd issues
around nested lists that are resolved with this change.
2020-06-05 09:50:22 -06:00
Anthony 67008af78f Merge pull request #940 from readthedocs/agj/add-package-lock-bump2version
Also change the package lock file
2020-06-05 09:48:45 -06:00
Anthony Johnson 0272204bf9 Regenerate assets 2020-06-05 09:42:53 -06:00
Anthony Johnson 10de27a0c7 Also change the package lock file
This was missed and not picked up until after release.
2020-06-05 09:38:30 -06:00
Anthony 77d95c9060 Merge pull request #941 from readthedocs/agj/parameter-colon
Add colon after field list terms
2020-06-05 09:37:17 -06:00
Anthony Johnson 67d2a08419 Add colon after field list terms
Currently, python method parameter/etc field lists are the same class as
general field lists, so we can't treat them differently. This reverts
styling the field list without the colon for now, and is comparable to
how the HTML 4 writer outputs field/parameter lists.
2020-06-04 15:55:59 -06:00
Santos Gallegos bdd77df7bb Search page: don't show "edit on" links
This page is autogenerated, so it doesn't have "a real page".

Fixes https://github.com/readthedocs/sphinx_rtd_theme/issues/934
2020-06-01 14:02:08 -05:00
David Fischer 48a9c21b67 Merge pull request #929 from xi/fix-list-style-cascade
fix list style on nested lists
2020-05-21 15:03:29 -07:00
Tobias Bengfort 1379b98415 fix list style on nested lists 2020-05-20 11:56:15 +02:00
Anthony 01ea6c71a6 Merge pull request #917 from readthedocs/agj/fix-fout
Change FOUT back to FOIT
2020-05-07 14:24:20 -06:00
Anthony Johnson fe33f6c5de Change FOUT back to FOIT
The fonts loaded in 0.4.3 did not have a configuration for the CSS
`font-display`, and they were switched to `font-display: swap` in
0.5.0rc1. The old behavior was FOIT, and `swap` changed the behavior to
FOUT, which was more noticeable. This changes back to a long block
period while the fonts are loading.

For more information on the FOUT/FOIT and the font-display mechanism:
https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display
2020-05-07 12:27:46 -06:00
Anthony 8494a58358 Merge pull request #915 from readthedocs/agj/fix-dl-simple
Address issue with dl.simple definition lists
2020-05-07 12:22:00 -06:00
Anthony Johnson 33625141ec Address issue with dl.simple definition lists
This was not a test case in our demo docs, and I'm still not entirely
sure why the style needs to be different. 🤷

Fixes #913
2020-05-06 19:24:30 -06:00
Anthony Johnson 8732ce06b5 Bump to next release, 0.5.0rc2 or greater 2020-05-06 16:14:39 -06:00
Anthony 7de6da682c Merge pull request #912 from readthedocs/release/0.5.0rc1
Release 0.5.0rc1
2020-05-06 15:52:19 -06:00
Anthony Johnson 729ac2f5b9 Release 0.5.0rc1
This is a release candidate for 0.5.0, which adds support for both HTML4
and HTML5 writers, which should support the default writer regardless of
your version of Sphinx.

Also included in this release are localization efforts and 10 language
translations.

You will need to specify the release manually to test, if there are no
major issues, we will have a 0.5.0 release shortly.

Closes #886
Closes #712
2020-05-06 15:22:02 -06:00
Anthony 6cd6162937 Merge pull request #822 from readthedocs/use-bumpversion
Use bumpversion for version number management
2020-05-06 15:12:34 -06:00
Anthony bcb142a463 Merge branch 'master' into use-bumpversion 2020-05-06 15:06:10 -06:00
Anthony Johnson b4769ec0ae Start off with 0.4.3alpha1
We use a 1-based indexing for dev part as `rc0` sounds funny. This was
also a test commit of the change.
2020-05-06 14:53:43 -06:00
Anthony Johnson 512ad422d1 Move bumpversion config and reconfigure
I moved the configuration to setup.cfg, with the rest of the tooling
configurations.

I had trouble getting the parsing to work for both the current pattern
that exists in this repository (`0.4.3.dev0`), and the pattern we use in
other repositories (`0.4.3alpha1` and `0.4.3rc1`).

The release pattern would potentially be:

* Version is `0.4.3alpha1`
* Bump to `0.5.0alpha1` or `0.5.0rc1` for testing release, `0.5.0` for
  full release
* Commit, tag, etc the new release
* Release to PyPI
* Bump to `0.5.1alpha1` and commit. This is the next development release
  that would be in `master` branch
2020-05-06 14:47:03 -06:00
Anthony d71b3f6602 Merge pull request #911 from readthedocs/agj/tune-localization
Update transifex usage and localization context
2020-05-06 14:36:03 -06:00
Anthony c4601fe12c Merge pull request #906 from mondeja/upgrade-node-sass
Upgrade node-sass to avoid security vulnerabilty
2020-05-06 14:35:22 -06:00
Anthony 2780e66779 Merge branch 'master' into upgrade-node-sass 2020-05-06 14:28:30 -06:00
Anthony 9a14187f4e Merge branch 'master' into agj/tune-localization 2020-05-06 14:22:07 -06:00
Anthony 4bab2fd843 Merge pull request #909 from readthedocs/agj/i18n-20200502
Update translations
2020-05-06 14:02:51 -06:00
Anthony Johnson 25cedf59e3 Update all translations from transifex
This uses the transifex changes in #911 to regenerate all of the files
from transifex. Any differences in the translated files should be
handled at transifex, as it looks there were some manual translations
that were overridden in this process.
2020-05-06 13:42:45 -06:00
Anthony Johnson de63fe9526 Also, pull all translations 2020-05-06 13:33:07 -06:00
Anthony Johnson 67f6b26bfd Tune translation strings and extract 2020-05-06 13:25:19 -06:00
Anthony Johnson 7efb81803e Update transifex usage
This uses force mode to download po files, always. Normal operation is
to use the file modification date for comparison, which doesn't work
because of Git.

This also sets `onlyreviewed` mode, which will omit strings which are
not translated yet. This will result in the underlying source
translation being used in place, until the string is reviewed in
transifex.
2020-05-06 13:24:14 -06:00
Anthony a13a7b4b44 Merge pull request #838 from readthedocs/agj/fix-dl-styles
Address Sphinx 2 compatibility issues
2020-05-05 14:39:06 -06:00
Anthony Johnson f4c56d044b Regenerate assets 2020-05-05 14:16:29 -06:00
AnthonyandDavid Fischer 18681b5eba Increase left padding on field lists and footnotes
Co-authored-by: David Fischer <david@readthedocs.org>
2020-05-05 14:16:29 -06:00
Anthony Johnson 8a47eef3c4 Add definition list classifier pretext 2020-05-05 14:16:29 -06:00
Anthony Johnson fb84183e71 Remove debug line 2020-05-05 14:16:29 -06:00
Anthony Johnson 31e8ec71b5 Debug log theme location 2020-05-05 14:16:29 -06:00
Anthony Johnson 16d874d984 Use the local theme for PR builds on RTD 2020-05-05 14:16:29 -06:00
Anthony Johnson 20ca43724c Trigger PR builder with latest Sphinx version 2020-05-05 14:16:29 -06:00
Anthony Johnson ce04147bb3 Drop travis docs project, we're already building them 27 times 2020-05-05 14:16:29 -06:00
Anthony Johnson ca75c343e2 Just drop Sphinx 1.5, the translator exception is not due to this theme 2020-05-05 14:16:28 -06:00
Anthony Johnson 1dd3cd0988 Alter travis python versions 2020-05-05 14:16:28 -06:00
Anthony Johnson 8534484967 Limit theme registration to 1.6+
This call was added in 1.6
2020-05-05 14:16:28 -06:00
Anthony Johnson 69e594d6a1 Regenerate assets 2020-05-05 14:16:28 -06:00
Anthony Johnson 8a08ebec1a Prune tox Sphinx/Python versions 2020-05-05 14:16:28 -06:00
Anthony Johnson e9b5b5b4a0 Clean up a number of issues with lists, tables, and footnotes
This is using CSS `grid` on the html5 writer, which is mostly supported
by now.
2020-05-05 14:16:28 -06:00
Anthony Johnson 20abc2fc1c Add method to test badge only CSS
Also a small bug fix I found to line-height.
2020-05-05 14:16:28 -06:00
Anthony Johnson ebc87bc0a2 Address Sphinx 2 compatibility issues
The main change here is that we load information into the template so
that CSS can make decisions about what element hierarchy it can expect,
instead of covering both html4 and html5 writer with a single set of
rules. I also fixed the tox config so that it generates docs for
testing.

This is also in part going to revert the changes in #785. Instead of
maintaining a list of `dl` classes to apply the domain styles to, this
PR instead maintains a list of definition list classes to *not* apply
the domain definition list styling too. There are too many possibilities
to cover with an include list.
2020-05-05 14:16:28 -06:00
Eric Holscher c3a9306b8d Merge pull request #908 from readthedocs/agj/better-webpack-dev-server
Improve webpack dev server
2020-05-04 14:48:26 -07:00
Aaron Carlisle cb16df13b4 Merge branch 'master' into agj/better-webpack-dev-server 2020-05-04 16:41:16 -04:00
Álvaro Mondéjar 0f7fb8b426 Merge branch 'master' into upgrade-node-sass 2020-05-03 14:24:45 +02:00
Anthony db4fae9837 Merge pull request #905 from mondeja/patch-1
Fix indentation consistence
2020-05-02 16:04:53 -06:00
Anthony Johnson 0eab0dcbdf Make webpack dev server config to be more useful
Don't rebuild the docs constantly, use the nice webpack livereload
feature instead. Changes are now instantaneous when working with CSS/JS
2020-05-01 20:38:10 -06:00
Álvaro Mondéjar d068e83488 Upgrade node-sass to avoid security vulnerabilty 2020-04-26 15:18:40 +02:00
Álvaro Mondéjar cbecb5906c Fix indentation consistence 2020-04-26 15:13:23 +02:00
Aaron Carlisle 3503493094 Remove Extra Padding on Highlighted search results (#860)
* Remove Extra Padding on Highlighted search results

There are some cases where the highlighted CSS class creates overlapping text, for example on [Rendering » Shader Nodes » Texture](https://docs.blender.org/manual/en/dev/render/shader_nodes/textures/index.html?highlight=texture) when highlighting "texture". 

This issue is exacerbated by some custom styling rules that we have set, however, this issue is still visible in the stock theme.

* Address Review Comments

- Use constant instead of a magic number
- Remove Padding
2020-04-06 11:30:15 -04:00
mondeja fd6f31fc14 Fix bold error for 5th level toctree on first click. (#895) 2020-04-04 17:48:58 -04:00
mondeja e8736948d6 As was reported in #881, using the singlehtml builder, the captions for figures appears with 'font-size: 150%'. This is because '.toctree-wrapper p.caption' definitions was inserted to style '.toctree-wrapper compound' divs titles at readthedocs index page, but the h2 extend affects also to elements that are deeper in the dom tree, like caption figures. However, we can style only direct 'p.caption' childs of '.toctree-wrapper' divs because these titles are not appearing at any other place. The pull request that I sent does not fixes this problem, but this commit yes. (#892) 2020-03-26 17:39:01 -04:00
Sebastian WeigandandAaron Carlisle ca015a5704 Extend toc in sidebar indentation (#852)
* added vscode config to .gitignore

* implemented indentation for sidebar nav up to navigation_depth of 10

* removed .vscode from .gitignore

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2020-02-24 21:55:07 -05:00
Jan Niklas HasseandAaron Carlisle b3aa66d657 Add German translation, fix #587 (#873)
Based on the translation by Dennis Wegner <dennis@instant-thinking.de>.

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2020-02-24 21:48:58 -05:00
Povilas KanapickasandAaron Carlisle dfec3b7bce Mark the extension as safe for parallel reading and writing (#874)
Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2020-02-23 12:13:13 -05:00
rdbandAaron Carlisle d8bd069e52 Move CSS link tags before JS script tags (#853)
This fixes flickering issues when switching pages.

Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
2020-02-23 12:05:12 -05:00
David Fischer 68a19ca510 Update JS dependencies (#867)
* Update JS dependencies

- This should fix the github JS vulns warning

* Remove matchdep as a dependency
2020-01-20 12:56:39 -05:00
Anthony ab7d388448 Merge pull request #845 from readthedocs/Blendify/fix-787
Don't allow select on code block shell prefixes
2019-11-11 11:58:50 -07:00
Anthony 31892ff84d Merge branch 'master' into Blendify/fix-787 2019-11-11 11:45:16 -07:00
Anthony 2b8717a364 Merge pull request #848 from readthedocs/html5shivwebpack
Remove Modernizr, keep html5shiv (Webpack edition)
2019-11-08 13:27:50 -07:00
Anthony d040bbace6 Merge branch 'master' into Blendify/fix-787 2019-11-01 11:54:00 -06:00
Aaron Carlisle 80ad848bfc Correct Sass syntax 2019-10-26 10:35:13 -04:00
Jesse Tan 12458e0a6a Remove Modernizr, keep html5shiv (Webpack edition) 2019-10-25 14:54:52 +02:00
Anthony 2a1b2e1353 Merge pull request #844 from readthedocs/blendify/fix-837
Fix  #837 Duplicate CSS Properties
2019-10-24 10:32:41 -06:00
Anthony b22ac46414 Merge branch 'master' into blendify/fix-837 2019-10-24 10:25:30 -06:00
Anthony 36bca69a8f Merge pull request #846 from readthedocs/blendify/code-console
Docs: Fix use of code console
2019-10-24 10:22:43 -06:00
Anthony 00195f6945 Merge branch 'master' into blendify/fix-837 2019-10-24 10:17:41 -06:00
Aaron Carlisle a4bacd2bab Docs: Fix use of code console 2019-10-23 11:08:08 -04:00
Reinout van Rees c04c214a85 Documenting that google analytics is supported (#829)
See #411, released in `0.4.3`. It is now supported, so I've changed the documentation accordingly.
2019-10-23 04:36:31 -04:00
Aaron Carlisle 9138108f7f Fix #787 2019-10-22 16:53:53 -04:00
Aaron Carlisle 256c3f2cbb Fix #837 Duplicate CSS Properties 2019-10-22 16:45:50 -04:00
Anthony Johnson db0f25787c Merge branch 'agj/more-webpack-fixes' 2019-10-17 10:34:34 -06:00
Anthony Johnson 6cfc95fb0e Remove extra font path again. 2019-10-15 16:37:13 -06:00
David Fischer 83540ff93f Upgrade and unpin sass-loader 2019-10-15 16:31:22 -06:00
David Fischer d87006d384 Commit package-lock.json 2019-10-15 16:31:22 -06:00
Anthony Johnson 4549aaa56e Also update the files included in the package
Adds moved font files
2019-10-15 16:31:22 -06:00
Anthony Johnson ff594d23ff Fix a number of issues with Webpack
A few of these squeezed by QA and testing:

* badge_only.css was copied to the static output path, it wasn't
  actually building it seems. Added second entry for this to make it
  easier.
* jQuery was not being treated as an external library and was vendored
  into our JS bundle!
* Having the fonts in a relative path from CSS ('../fonts'), causes CORS
  issues. Moved `/fonts` to `/sphinx_rtd_theme/static/css/fonts` essentially
* The dev server wasn't compiling assets consistently for me, tuned it hopefully

Requires #807
2019-10-15 16:31:22 -06:00
Anthony 1d6f240a57 Merge pull request #826 from readthedocs/davidfischer/setuppy-fixes
Small fixes to setup.py
2019-10-14 13:55:40 -06:00
David Fischer d4466432ea Small fixes to setup.py
Ensure `setup.py build` and `setup.py test`
work on a clean repo
2019-10-08 15:26:20 -07:00
Jesse Tan 8d484197f2 Also bump version in documentation conf.py 2019-10-03 20:48:58 +02:00
Jesse Tan 80580324c8 Update instructions 2019-10-03 20:37:52 +02:00
Jesse Tan 6fce074312 Also bump package.json 2019-10-03 20:27:53 +02:00
Anthony ddf840cb72 Merge pull request #809 from readthedocs/agj/setup-webpack-commands
Add webpack commands into setup.py
2019-10-03 10:51:53 -06:00
Anthony 6947fea9c0 Merge branch 'master' into agj/setup-webpack-commands 2019-10-03 10:43:17 -06:00
Jesse Tan 085eb32179 Use bump2version for version number management 2019-10-03 12:09:36 +02:00
Anthony feb0beb44a Merge pull request #807 from readthedocs/agj/format-webpack-js
Run webpack js through Prettier JS formatter
2019-08-22 12:45:22 -06:00
Anthony b3143a5811 Merge branch 'master' into agj/format-webpack-js 2019-08-22 12:39:37 -06:00
AnthonyandJesse Tan 9fee2a2585 Update setup.py
Co-Authored-By: Jesse Tan <jessetan@users.noreply.github.com>
2019-08-22 12:33:15 -06:00
AnthonyandJesse Tan 04f5c9281c Update setup.py
Co-Authored-By: Jesse Tan <jessetan@users.noreply.github.com>
2019-08-22 12:33:05 -06:00
Manuel Kaufmann 5ba05cd1fa Remove "Free document hosting provided by Read the Docs" message (#811)
Remove "Free document hosting provided by Read the Docs" message
2019-08-22 14:26:08 +02:00
Manuel Kaufmann 39a7172f55 Remove "Free document hosting provided by Read the Docs" message 2019-08-21 16:00:50 +02:00
Anthony 6909b4acb2 Merge pull request #805 from readthedocs/agj/more-api-docs
Add more domain doc examples
2019-08-03 08:59:53 -06:00
Eric Holscher 604fe08d19 Merge branch 'master' into agj/more-api-docs 2019-07-31 16:23:56 -07:00
Anthony Johnson 28ca8458a3 Old classes are The Worst 2019-07-29 11:29:49 -06:00
Anthony Johnson 00cc82c2f2 Not an object class anyways, drop super 2019-07-29 11:10:31 -06:00
Anthony Johnson af521d644d Make super() py2/3 compat 2019-07-29 11:04:41 -06:00
Anthony Johnson 4672249962 Fix webpack command to run in CI 2019-07-29 10:56:44 -06:00
Anthony Johnson e2a173d393 Add webpack commands into setup.py
This is a POC that shows building webpack through standard `setup.py`
commands. Any call to `setup.py build` or `bdist` or `sdist` will
trigger a Webpack build of the assets first. A non-zero exit code will
halt the process.

Also, moved the `npm run dev` command, which here is `python setup.py
watch`, though there is perhaps something better here. There is already
`python setup.py develop`, which has a separate function, so I don't
want to collide there.

Example output here:
https://gist.github.com/agjohnson/cdaab364fe598daa7f3bef750cfb84dd

Refs #797
2019-07-26 17:14:36 -06:00
Anthony a732d61d27 Merge pull request #804 from readthedocs/agj/force-neat-19
Comment on why bourbon-neat is pinned
2019-07-26 16:19:05 -06:00
Anthony abc57aa633 Merge branch 'master' into agj/force-neat-19 2019-07-26 15:53:46 -06:00
Anthony Johnson 2d874544b2 Run webpack js through Prettier JS formatter
Uses Prettier with no options. I'm fine accepting this as the default
style for our Javascript and autoformatting src/js/*.js as well. I left
those changes out for now.
2019-07-26 15:35:35 -06:00
Anthony Johnson 9b58009a97 Add a bit more error logging to preinstall check 2019-07-26 09:35:10 -06:00
Anthony 78287f0634 Merge pull request #806 from readthedocs/agj/more-localization
Add more localized strings
2019-07-26 09:27:44 -06:00
Anthony Johnson 8f327360a5 Add more localized strings
This adds altext on the home icon, copyright is already translated on the footer.html

Fixes #795
2019-07-25 19:43:39 -06:00
Anthony Johnson 1bfa504f97 Add more domain doc examples
These are a few domain examples pulled from the Sphinx test doc roots.
2019-07-25 19:27:22 -06:00
Anthony Johnson 35320c29f6 Comment on why bourbon-neat is pinned
This will actually fail `npm install` if you try upgrading the version.
2019-07-25 19:12:34 -06:00
Anthony b360305d0f Merge pull request #785 from readthedocs/style-cpp-domain
Fix styling of generated cpp documentation
2019-07-25 19:08:45 -06:00
Anthony Johnson 10d9f512ad Merge branch 'master' into style-cpp-domain 2019-07-25 18:11:13 -06:00
Anthony 7e0d7933ad Merge pull request #790 from RDIL/master
Update dev dependencies
2019-07-25 17:36:20 -06:00
Reece Dunham e343390ed6 back to working version as requested 2019-07-25 18:41:00 -04:00
Reece Dunham 7420e7bab3 Merge pull request #9 from RDIL/dependabot/npm_and_yarn/css-loader-tw-3.1.0
Update css-loader requirement from ^2.1.1 to ^3.1.0
2019-07-25 18:34:43 -04:00
dependabot-preview[bot] 1001668088 Update css-loader requirement from ^2.1.1 to ^3.1.0
Updates the requirements on [css-loader](https://github.com/webpack-contrib/css-loader) to permit the latest version.
- [Release notes](https://github.com/webpack-contrib/css-loader/releases)
- [Changelog](https://github.com/webpack-contrib/css-loader/blob/master/CHANGELOG.md)
- [Commits](https://github.com/webpack-contrib/css-loader/compare/v2.1.1...v3.1.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-25 22:34:15 +00:00
Reece Dunham 6504b761c2 Merge pull request #10 from RDIL/dependabot/npm_and_yarn/bourbon-neat-approx-4.0
Update bourbon-neat requirement from ~1.9 to ~4.0
2019-07-25 18:32:33 -04:00
dependabot-preview[bot] 83a93b7470 Update bourbon-neat requirement from ~1.9 to ~4.0
Updates the requirements on [bourbon-neat](https://github.com/thoughtbot/neat) to permit the latest version.
- [Release notes](https://github.com/thoughtbot/neat/releases)
- [Changelog](https://github.com/thoughtbot/neat/blob/master/CHANGELOG.md)
- [Commits](https://github.com/thoughtbot/neat/compare/v1.9.0...v4.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-25 22:31:17 +00:00
Reece Dunham 1443834231 Merge branch 'master' into master 2019-07-25 18:27:26 -04:00
Anthony 8fbf2c0696 Merge pull request #771 from SimonBiggs/swap-to-webpack
Swap to using webpack
2019-07-25 16:24:25 -06:00
Anthony Johnson a591817abe Forgot a changelog entry 2019-07-25 16:18:34 -06:00
Anthony Johnson 94d574349f Review fixes on typo and missing change to package.json 2019-07-25 15:46:31 -06:00
Anthony Johnson 472b3aee21 Final doc updates and fix tests 2019-07-25 14:08:56 -06:00
Anthony Johnson 9a8699b915 Merge branch 'master' into swap-to-webpack 2019-07-25 13:40:17 -06:00
Anthony 26b72a7c61 Merge branch 'master' into style-cpp-domain 2019-07-25 13:27:17 -06:00
Anthony 563d494e45 Merge pull request #793 from readthedocs/agj/update-translations-rebase
Finalized addition of theme localization
2019-07-25 13:21:24 -06:00
Anthony f38476ec89 Merge branch 'master' into agj/update-translations-rebase 2019-07-25 00:30:04 -06:00
Anthony Johnson d426c11cea Merge branch 'master' into agj/update-translations-rebase 2019-07-25 00:07:44 -06:00
Anthony Johnson 1ef6b5b3b4 Undo gruntfile changes 2019-07-24 23:55:34 -06:00
Anthony Johnson ad31326e3a Some final cleanup 2019-07-24 23:53:25 -06:00
Anthony Johnson 5052143f79 Undoing test fixes 2019-07-24 23:42:25 -06:00
Anthony Johnson 0e0ccffe18 Replace with requirements file, RTD doesn't handle these patterns well. 2019-07-24 23:36:13 -06:00
Anthony Johnson 16e36af58c Another test 2019-07-24 19:24:16 -06:00
Anthony Johnson ec7704800d Another test 2019-07-24 18:46:43 -06:00
Anthony Johnson 715c0beacb Add commands into setup.py and regenerate translations
More fixes for docs
2019-07-24 18:39:35 -06:00
Reece Dunham 5370bed9ad Merge pull request #7 from RDIL/dependabot/npm_and_yarn/grunt-exec-approx-3.0.0
Update grunt-exec requirement from ~1.0.1 to ~3.0.0
2019-07-24 09:30:00 -04:00
Reece Dunham 362436873c Merge branch 'master' into dependabot/npm_and_yarn/grunt-exec-approx-3.0.0 2019-07-24 09:29:54 -04:00
dependabot-preview[bot] 30a6926955 Update grunt-exec requirement from ~1.0.1 to ~3.0.0
Updates the requirements on [grunt-exec](https://github.com/jharding/grunt-exec) to permit the latest version.
- [Release notes](https://github.com/jharding/grunt-exec/releases)
- [Commits](https://github.com/jharding/grunt-exec/compare/v1.0.1...v3.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-24 13:29:10 +00:00
Reece Dunham 302d8e53e7 Merge pull request #8 from RDIL/dependabot/npm_and_yarn/grunt-open-0.2.4
Update grunt-open requirement from 0.2.3 to 0.2.4
2019-07-24 09:28:30 -04:00
Reece Dunham 4edce2ea5c Merge branch 'master' into dependabot/npm_and_yarn/grunt-open-0.2.4 2019-07-24 09:28:19 -04:00
Reece Dunham d4f229fa32 Merge pull request #5 from RDIL/dependabot/npm_and_yarn/grunt-contrib-connect-tw-2.0.0
Update grunt-contrib-connect requirement from ^1.0.2 to ^2.0.0
2019-07-24 09:27:42 -04:00
Reece Dunham 3acba54ebd Merge pull request #4 from RDIL/dependabot/npm_and_yarn/grunt-contrib-watch-approx-1.1.0
Update grunt-contrib-watch requirement from ~1.0.0 to ~1.1.0
2019-07-24 09:27:30 -04:00
dependabot-preview[bot] 53713771ab Update grunt-contrib-connect requirement from ^1.0.2 to ^2.0.0
Updates the requirements on [grunt-contrib-connect](https://github.com/gruntjs/grunt-contrib-connect) to permit the latest version.
- [Release notes](https://github.com/gruntjs/grunt-contrib-connect/releases)
- [Changelog](https://github.com/gruntjs/grunt-contrib-connect/blob/master/CHANGELOG)
- [Commits](https://github.com/gruntjs/grunt-contrib-connect/compare/v1.0.2...v2.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-24 13:27:23 +00:00
dependabot-preview[bot] 9a4880ed9e Update grunt-open requirement from 0.2.3 to 0.2.4
Updates the requirements on [grunt-open](https://github.com/onehealth/grunt-open) to permit the latest version.
- [Release notes](https://github.com/onehealth/grunt-open/releases)
- [Commits](https://github.com/onehealth/grunt-open/compare/v0.2.3...v0.2.4)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-24 13:27:20 +00:00
dependabot-preview[bot] f46f3a8051 Update grunt-contrib-watch requirement from ~1.0.0 to ~1.1.0
Updates the requirements on [grunt-contrib-watch](https://github.com/gruntjs/grunt-contrib-watch) to permit the latest version.
- [Release notes](https://github.com/gruntjs/grunt-contrib-watch/releases)
- [Changelog](https://github.com/gruntjs/grunt-contrib-watch/blob/master/CHANGELOG)
- [Commits](https://github.com/gruntjs/grunt-contrib-watch/compare/v1.0.0...v1.1.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-24 13:27:20 +00:00
Reece Dunham e5f612dad2 Merge pull request #3 from RDIL/dependabot/npm_and_yarn/browserify-tw-16.3.0
Update browserify requirement from ^13.0.0 to ^16.3.0
2019-07-24 09:26:38 -04:00
Reece Dunham 770ca0206a Merge pull request #6 from RDIL/dependabot/npm_and_yarn/matchdep-approx-2.0.0
Update matchdep requirement from ~1.0.1 to ~2.0.0
2019-07-24 09:26:15 -04:00
Reece Dunham 9ed9a6c99d Merge pull request #2 from RDIL/dependabot/npm_and_yarn/grunt-contrib-uglify-approx-4.0.1
Update grunt-contrib-uglify requirement from ~3.3.0 to ~4.0.1
2019-07-24 09:25:47 -04:00
Reece Dunham 0749c809b3 Merge pull request #1 from RDIL/dependabot/npm_and_yarn/grunt-contrib-clean-tw-2.0.0
Update grunt-contrib-clean requirement from ^1.0.0 to ^2.0.0
2019-07-24 09:25:37 -04:00
dependabot-preview[bot] 5ed692af77 Update matchdep requirement from ~1.0.1 to ~2.0.0
Updates the requirements on [matchdep](https://github.com/tkellen/js-matchdep) to permit the latest version.
- [Release notes](https://github.com/tkellen/js-matchdep/releases)
- [Commits](https://github.com/tkellen/js-matchdep/compare/v1.0.1...v2.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-24 13:22:46 +00:00
dependabot-preview[bot] b301bb2024 Update browserify requirement from ^13.0.0 to ^16.3.0
Updates the requirements on [browserify](https://github.com/browserify/browserify) to permit the latest version.
- [Release notes](https://github.com/browserify/browserify/releases)
- [Changelog](https://github.com/browserify/browserify/blob/master/changelog.markdown)
- [Commits](https://github.com/browserify/browserify/compare/13.0.0...v16.3.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-24 13:20:47 +00:00
dependabot-preview[bot] 3cecffc34d Update grunt-contrib-uglify requirement from ~3.3.0 to ~4.0.1
Updates the requirements on [grunt-contrib-uglify](https://github.com/gruntjs/grunt-contrib-uglify) to permit the latest version.
- [Release notes](https://github.com/gruntjs/grunt-contrib-uglify/releases)
- [Changelog](https://github.com/gruntjs/grunt-contrib-uglify/blob/master/CHANGELOG)
- [Commits](https://github.com/gruntjs/grunt-contrib-uglify/compare/v3.3.0...v4.0.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-24 13:19:41 +00:00
dependabot-preview[bot] f34e0851dd Update grunt-contrib-clean requirement from ^1.0.0 to ^2.0.0
Updates the requirements on [grunt-contrib-clean](https://github.com/gruntjs/grunt-contrib-clean) to permit the latest version.
- [Release notes](https://github.com/gruntjs/grunt-contrib-clean/releases)
- [Changelog](https://github.com/gruntjs/grunt-contrib-clean/blob/master/CHANGELOG)
- [Commits](https://github.com/gruntjs/grunt-contrib-clean/compare/v1.0.0...v2.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-07-24 13:19:08 +00:00
Anthony Johnson d216dcf54d Fix local path insertion of package, fix more docs
Add back git installation docs, we'll discuss this separately.
2019-07-19 15:29:24 -06:00
Anthony Johnson f7a7cd75eb Update build directions, better install mechanism, NL locale 2019-07-19 12:56:02 -06:00
Anthony Johnson 69c1e095f6 Update po file comments, tune installation requirements, alter i18n scripts 2019-07-19 12:46:11 -06:00
AnthonyandJesse Tan 3eef5eb69b Change code bash to console
Co-Authored-By: Jesse Tan <jessetan@users.noreply.github.com>
2019-07-19 11:35:12 -06:00
Anthony Johnson cb87d8f406 Drop yarn lock, move deps to devdeps in package.json 2019-07-19 11:05:27 -06:00
Anthony Johnson c5d01ad3e6 Merge branch 'agj/more-webpack' into swap-to-webpack 2019-07-19 10:57:21 -06:00
Anthony Johnson af7d610bb9 Pin Neat v1.9 to avoid node-gyp 3.8 2019-07-19 10:50:54 -06:00
Jesse Tan 68f38ddec2 Fix styling of generated cpp documentation 2019-07-19 16:10:38 +02:00
Anthony Johnson fb934e0916 Change port and do make clean build 2019-07-18 16:51:27 -06:00
Anthony Johnson 006921a145 A few additions for migration to webpack
* Fix issues on paths in build and dev files
* Skip yarn to reduce tooling requirements
* Minify CSS assets in production
* Reduce imports on fonts, hardcode font pieces more. There are problems
  with the font family names. Roboto mixin brings in everything as
  `Roboto-Slab-Bold`, which won't match local font name of 'Roboto Slab'
* Fix the development instance more:
  * Add file watching on reST files
  * Execute build docs command after webpack build

Things I'm still not sure about:

- [ ] The actual JS output, I haven't vetted this yet
- [ ] If woff2 and woff are enough for fonts. The NPM packages are missing other formats
2019-07-17 23:37:55 -06:00
Aaron Carlisle bad21120c8 Horizontal Lists: Use full width (#775)
* Horizontal Lists: Use full width

* Cleanup: Whitespace
2019-07-17 20:54:29 -04:00
Anthony ad7a8a4757 Merge pull request #774 from readthedocs/Blendify/breadcrumbs-icon
Breadcrumbs use home icon instead of "Docs"
2019-07-17 17:59:09 -06:00
Anthony ed9cdf00f5 Merge branch 'master' into Blendify/breadcrumbs-icon 2019-07-17 17:10:38 -06:00
Anthony 347a08fbd8 Merge pull request #780 from kevinanewman/patch-1
Update README.rst
2019-07-17 17:07:13 -06:00
Kevin Newman dbbf11ec9d Update README.rst
Apparent typo fix for package name
2019-07-17 08:52:04 -04:00
Anthony Johnson caa3373297 Continuation of adding translations to theme
This builds on top of #405, addressing the outstanding review feedback. It:

* Moves workflow to our standard Transifex workflow, drops recommendation for
  running babel commands by hand
* Configures Transifex
* Moves all of the commands needed to maintain translations into Grunt
* Sets up docs for translation testing
* Covers installation in docs better
* Drops recommendation for installation through submodules
* Drops superfluous translation documentation
* Cleans up some of the code
* Updates a lot of related documentation
* Updates files at Transifex and brings in full translations back to the
  translation files in the repository
2019-07-16 20:31:31 -06:00
Aaron Carlisle f787cceadf Breadcrumbs use home icon instead of "Docs"
This gives more room for longer breadcrumbs and makes the theme a little bit more generic. For example, people might use the theme for other purposes then hosting "docs".
2019-07-08 21:32:34 -04:00
Jesse Tan f237820d2c Merge pull request #755 from readthedocs/fix-752
Scope autodoc styling to .class and .data for Sphinx 2.0
2019-07-04 20:02:12 +02:00
Simon Biggs 0ab76453ac commit the built files 2019-07-02 20:22:59 +10:00
Simon Biggs beca6ea743 successful build with webpack 2019-07-02 20:17:20 +10:00
Aaron Carlisle 0f8268bb21 Merge branch 'master' into fix-752 2019-06-30 21:02:45 -04:00
Hugo Locurcio 020f5a4bd0 Use font-display: swap to ensure faster Web font display (#742)
See https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-display
for more information.
2019-06-26 21:25:07 +02:00
Jesse Tan 29bf998f40 Merge branch 'master' into fix-752 2019-06-26 20:16:07 +02:00
David Fischer 2a832aeb77 Merge pull request #762 from DatCorno/patch-1
Add missing word to demo.rst
2019-05-17 10:03:19 -07:00
François Corneau-Tremblay 5fa283bf75 Update demo.rst
There is a missing word in the documentation here.
2019-05-17 11:39:12 -04:00
Jesse Tan b3e894b70f Scope autodoc styling to .class and .data for Sphinx 2.0 2019-04-28 16:40:35 +02:00
Aaron Carlisle a49a812c88 Remove deprecated use of script_files (#728)
* Remove deprecated use of script_files

Fixes https://github.com/sphinx-doc/sphinx/issues/6088

* Add script block

* Fix build error
2019-04-03 10:42:19 -04:00
Aaron Carlisle f9a2fe45d3 Update .travis.yml 2019-03-07 09:46:56 -05:00
Aaron Carlisle 7050db07bf Merge branch 'master' into master 2019-03-07 09:39:35 -05:00
Aaron Carlisle 8992188965 Remove requirements file thats not needed 2019-03-06 10:18:50 -05:00
Aaron Carlisle 8ac46387ac Delete requirements.txt 2019-03-06 10:18:14 -05:00
David Fischer ddfdd35e69 Fix accessibility of sidebar nav (#734) 2019-02-28 17:42:43 -05:00
David Fischer 74cfda1e24 Fix a SASS typo (#733) 2019-02-28 17:35:35 -05:00
eduardo naufel schettino 8c31a26a79 Add `navigation` template block (#659)
* Add the ``extranav`` block after the ``menu`` block in the template.

* Use one big navigation block

* Update changelog.rst
2019-02-26 13:05:59 -05:00
Benjamin Bach 6c876607a5 Do not float elements next to admonition blocks #722 (#723) 2019-02-25 13:24:48 -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 ab89bb161f Revert change
Reverts fffca44dce
2018-11-05 10:49:31 -05:00
Aaron Carlisle fffca44dce Remove bad import 2018-11-05 10:44:30 -05:00
Aaron Carlisle cd34154857 Update changelog.rst 2018-11-05 10:38:28 -05:00
Aaron Carlisle 71c6d8ecf7 Requirements: Used numbered version 2018-11-05 10:36:36 -05:00
Aaron Carlisle 83b8084523 Merge branch 'master' into master 2018-11-04 13:34:35 -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
Aaron Carlisle ad66515256 Merge branch 'master' into master 2018-05-24 11:48:47 -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
Leonardo J. Caballero G f955d33154 Moved requirements install command from tox file into travis file and
fixed url from requirements file
2018-05-01 20:03:44 -04: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
Leonardo J. Caballero G 693454dd78 Added Sphinx 1.8.0 support for the testing on Travis-CI 2018-05-01 12:51:17 -04: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
Leonardo J. Caballero G 2f190b61d9 Updated Spanish translation 2018-05-01 10:02:44 -04:00
Leonardo J. Caballero G ae8debe101 Added and enabled add_message_catalog for theme using Sphinx 1.8.0 2018-05-01 10:01:07 -04: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
Leonardo J. Caballero G 3b50dc09aa Updated with more improvements translations guide 2018-04-18 18:42:23 -04:00
Leonardo J. Caballero G 50f7c8b245 Revert the original value for pygments_style to default 2018-04-18 18:39:00 -04:00
Leonardo J. Caballero G 9b0215ce6c Updated translation guite with the Pull request reviews 2018-04-18 17:54:38 -04:00
Leonardo J. Caballero G 8e835304d8 Added more improvements about i18n from Pull request reviews 2018-04-18 17:53:16 -04:00
Leonardo J. Caballero G e6008cecdd Removed output commands examples 2018-04-18 11:41:22 -04:00
David Fischer 41d251a706 Always bundle the theme CSS/JS 2018-04-17 23:11:02 -07:00
Leonardo J. Caballero G cb18bac4bb Updated changelog file~ 2018-04-17 20:06:31 -04:00
Leonardo J. Caballero G e53c739eef Fixed some typo 2018-04-17 19:28:50 -04:00
Leonardo J. Caballero G 5ddbabdcd4 Added more details informations about translations guide 2018-04-17 19:21:14 -04:00
Leonardo J. Caballero G 9c59240e50 Updated .gitignore file 2018-04-17 18:13:49 -04:00
Leonardo J. Caballero G 326a12eb56 Moved into sphinx_rtd_theme the locale directory 2018-04-17 18:05:34 -04:00
Leonardo J. Caballero G 45b72fa616 Added more improvements about i18n support for templates 2018-04-17 18:02:17 -04: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
Leonardo J. Caballero G bba0eedf35 Updated Babel configurations 2018-04-17 00:48:40 -04:00
Leonardo J. Caballero G c35a4eb535 Updated translations guide section 2018-04-17 00:30:55 -04:00
Leonardo J. Caballero G bbaef3aa7b Updated .gitignore file 2018-04-17 00:28:53 -04: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 a4fd6e01ef Docs: Move translation file 2018-04-14 15:37:46 -04:00
Aaron Carlisle cadb79f73d Update translations catalogs 2018-04-14 15:33:39 -04:00
Aaron Carlisle 81cd11d14f Revert unrelated changes 2018-04-14 15:33:00 -04:00
Aaron Carlisle 2858a0aec8 Merge branch 'master' of https://github.com/rtfd/sphinx_rtd_theme 2018-04-14 15:01:23 -04: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 bbc5394d8a Merge branch 'master' into master 2018-01-18 13:37:54 -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 d05b2a93c9 Merge branch 'master' into master 2017-12-19 11:16:34 -05: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 a48eb90130 Merge branch 'master' into caption-margin 2017-12-16 16:32:41 -05:00
Aaron Carlisle 01dfcff1b6 Merge branch 'master' into caption-margin 2017-12-16 00:12:09 -05:00
Aaron Carlisle 447b19501c Merge branch 'master' into master 2017-09-29 12:04:16 -04:00
Aaron Carlisle 4b1ff7890b Merge branch 'master' into master 2017-06-18 00:44:33 -04:00
Aaron Carlisle 1d1b2cd55d Merge branch 'master' into caption-margin 2017-06-18 00:04:49 -04:00
Aaron Carlisle fc9dfa5f43 Merge branch 'master' into master 2017-05-06 00:47:12 -04: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
Leonardo J. Caballero G 15d2198a45 Check spell 2017-04-14 10:54:18 -04:00
Leonardo J. Caballero G 3329e09479 Removed Sphinx and Babel command class from setup.py file and added a TRANSLATE file for more details about translate the package 2017-04-03 10:40:42 -04:00
Leonardo J. Caballero G 8f21fd0c0f Removed sphinx.mo file 2017-04-03 09:54:17 -04:00
Leonardo J. Caballero G 4cff61f2aa Updated way how import babel library to use for as command class options 2017-04-02 20:51:40 -04:00
Leonardo Caballero be27427d7b Revert commit ea89880 2017-04-02 10:13:18 -04:00
Leonardo J. Caballero G 7dadea5172 Added i18n support using Babel and Spanish translation 2017-04-01 08:59:46 -04:00
Leonardo J. Caballero G ea8988043c Updated .gitignore file 2017-04-01 08:35:43 -04:00
Aaron 9e2c93d2f5 line-block: set the left margin to 0px 2017-03-07 22:52:20 -05:00
140 changed files with 13640 additions and 1926 deletions

No files matched your search

+88
View File
@@ -0,0 +1,88 @@
version: 2.1
commands:
run-tox:
description: "Run tox"
parameters:
version:
type: string
sphinx-version:
type: string
default: "16,17,18,20,21,22,23,24,30,31,32,33,34,35,40,41,latest"
steps:
- checkout
- run: pip install --user tox
- run: tox -e "<<parameters.version>>-sphinx{<<parameters.sphinx-version>>}"
run-build:
description: "Ensure built assets are up to date"
steps:
- checkout
- run: npm ci
- run: npm run build
- run:
name: Ensure built assets are up to date
command: |
if [[ `git status sphinx_rtd_theme/ --porcelain` ]]
then
echo "ERROR: assets are out of date. Make sure to run 'npm run build' on your branch."
git status sphinx_rtd_theme/ --porcelain
exit 1
fi
jobs:
build:
docker:
- image: 'cimg/python:3.9-node'
steps:
- run-build: {}
py27:
docker:
- image: 'cimg/python:2.7'
steps:
- run-tox:
version: py27
py36:
docker:
- image: 'cimg/python:3.6'
steps:
- run-tox:
version: py36
py37:
docker:
- image: 'cimg/python:3.7'
steps:
- run-tox:
version: py37
py38:
docker:
- image: 'cimg/python:3.8'
steps:
- run-tox:
version: py38
py39:
docker:
- image: 'cimg/python:3.9'
steps:
- run-tox:
version: py39
workflows:
version: 2
tests:
jobs:
- build
- py39:
requires:
- build
- py38:
requires:
- build
- py37:
requires:
- build
- py36:
requires:
- build
- py27:
requires:
- build
+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
+34
View File
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'Bug, Needed: replication'
assignees: ''
---
### 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:
+12 -1
View File
@@ -6,9 +6,20 @@
.coverage
*.DS_Store
*.sass-cache
*.map
.ropeproject/
.ruby-version
dist/
bower_components/
node_modules/
include/
lib/
local/
node_modules
npm-debug.log
pip-selfcheck.json
sphinx_rtd_theme/static/fonts/Lato/
sphinx_rtd_theme/static/fonts/RobotoSlab/
.python-version
.node-version
sphinx_rtd_theme/static/js/html5shiv.min.js
sphinx_rtd_theme/static/js/html5shiv-printshiv.min.js
+11
View File
@@ -0,0 +1,11 @@
version: 2
python:
version: 3.8
install:
- requirements: docs/requirements.txt
- method: pip
path: .
sphinx:
configuration: docs/conf.py
-11
View File
@@ -1,11 +0,0 @@
language: python
python:
- 2.7
- 3.4
- 3.5
- 3.6
sudo: false
install:
- pip install tox-travis
script:
- tox
+9
View File
@@ -0,0 +1,9 @@
[sphinx-rtd-theme.sphinx-rtd-theme]
file_filter = sphinx_rtd_theme/locale/<lang>/LC_MESSAGES/sphinx.po
source_file = sphinx_rtd_theme/locale/en/LC_MESSAGES/sphinx.po
source_lang = en
minimum_perc = 60
[main]
host = https://www.transifex.com
type = PO
+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
-165
View File
@@ -1,165 +0,0 @@
module.exports = function(grunt) {
// load all grunt tasks
require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
grunt.initConfig({
open : {
dev: {
path: 'http://localhost:1919'
}
},
connect: {
server: {
options: {
port: 1919,
base: 'demo_docs/build',
livereload: true
}
}
},
copy: {
fonts: {
files: [
{
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/lato-googlefont/Lato-Regular.ttf',
'bower_components/lato-googlefont/Lato-Italic.ttf',
'bower_components/lato-googlefont/Lato-Bold.ttf',
'bower_components/lato-googlefont/Lato-BoldItalic.ttf'],
dest: 'sphinx_rtd_theme/static/fonts/',
filter: 'isFile'
},
{
expand: true,
flatten: true,
src: ['bower_components/robotoslab-googlefont/RobotoSlab-Bold.ttf',
'bower_components/robotoslab-googlefont/RobotoSlab-Regular.ttf'],
dest: 'sphinx_rtd_theme/static/fonts/',
filter: 'isFile'
},
{
expand: true,
flatten: true,
src: ['bower_components/inconsolata-googlefont/Inconsolata-Bold.ttf',
'bower_components/inconsolata-googlefont/Inconsolata-Regular.ttf'],
dest: 'sphinx_rtd_theme/static/fonts/',
filter: 'isFile'
}
]
}
},
sass: {
dev: {
options: {
style: 'expanded',
loadPath: ['bower_components/bourbon/dist', 'bower_components/neat/app/assets/stylesheets', 'bower_components/font-awesome/scss', 'bower_components/wyrm/sass']
},
files: [{
expand: true,
cwd: 'sass',
src: ['*.sass'],
dest: 'sphinx_rtd_theme/static/css',
ext: '.css'
}]
},
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: [{
expand: true,
cwd: 'sass',
src: ['*.sass'],
dest: 'sphinx_rtd_theme/static/css',
ext: '.css'
}]
}
},
browserify: {
dev: {
options: {
external: ['jquery'],
alias: {
'sphinx-rtd-theme': './js/theme.js'
}
},
src: ['js/*.js'],
dest: 'sphinx_rtd_theme/static/js/theme.js'
},
build: {
options: {
external: ['jquery'],
alias: {
'sphinx-rtd-theme': './js/theme.js'
}
},
src: ['js/*.js'],
dest: 'sphinx_rtd_theme/static/js/theme.js'
}
},
exec: {
bower_update: {
cmd: 'bower update'
},
build_sphinx: {
cmd: 'sphinx-build demo_docs/source demo_docs/build'
}
},
clean: {
build: ["demo_docs/build"],
fonts: ["sphinx_rtd_theme/static/fonts"]
},
watch: {
/* Compile sass changes into theme directory */
sass: {
files: ['sass/*.sass', 'bower_components/**/*.sass'],
tasks: ['sass:dev']
},
/* Changes in theme dir rebuild sphinx */
sphinx: {
files: ['sphinx_rtd_theme/**/*', 'demo_docs/**/*.rst', 'demo_docs/**/*.py'],
tasks: ['clean:build','exec:build_sphinx']
},
/* JavaScript */
browserify: {
files: ['js/*.js'],
tasks: ['browserify:dev']
},
/* live-reload the demo_docs if sphinx re-builds */
livereload: {
files: ['demo_docs/build/**/*'],
options: { livereload: true }
}
}
});
grunt.loadNpmTasks('grunt-exec');
grunt.loadNpmTasks('grunt-contrib-connect');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-contrib-sass');
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','browserify:dev','exec:build_sphinx','connect','open','watch']);
grunt.registerTask('build', ['exec:bower_update','clean:build','sass:build','browserify:build','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
+6
View File
@@ -1,5 +1,7 @@
include *.txt
include babel.cfg
include LICENSE
include bin/preinstall.js
recursive-include sphinx_rtd_theme *.conf
recursive-include sphinx_rtd_theme *.css
recursive-include sphinx_rtd_theme *.eot
@@ -9,3 +11,7 @@ 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 sphinx_rtd_theme/locale *.pot *.po *.mo
recursive-include tests *.py
recursive-include tests *.rst
prune build
+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.
+37 -302
View File
@@ -1,329 +1,64 @@
.. _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
.. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg
:target: https://pypi.python.org/pypi/sphinx_rtd_theme
.. image:: https://travis-ci.org/rtfd/sphinx_rtd_theme.svg?branch=master
:target: https://travis-ci.org/rtfd/sphinx_rtd_theme
.. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg
:target: https://pypi.python.org/pypi/sphinx_rtd_theme/
:alt: license
**************************
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://circleci.com/gh/readthedocs/sphinx_rtd_theme.svg?style=svg
:alt: Build Status
:target: https://circleci.com/gh/readthedocs/sphinx_rtd_theme
.. 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_.
This Sphinx_ theme was designed to provide a great reader experience for
documentation users on both desktop and mobile devices. This theme is used
primarily on `Read the Docs`_ but can work with any Sphinx project. You can find
a working demo of the theme in the `theme documentation`_
This is a mobile-friendly sphinx_ theme I made for readthedocs.org_.
If you'd like to update the theme,
please make your edits to the SASS files here,
rather than the .css files on checked into the repo.
.. image:: demo_docs/source/static/screen_mobile.png
:width: 100%
.. _Sphinx: http://www.sphinx-doc.org
.. _Read the Docs: http://www.readthedocs.org
.. _theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/latest/
Installation
============
Via package
-----------
This theme is distributed on PyPI_ and can be installed with ``pip``:
Download the package or add it to your ``requirements.txt`` file:
.. code:: console
.. code:: bash
$ pip install sphinx-rtd-theme
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()]
or (since v0.2.5):
To use the theme in your Sphinx project, you will need to edit
your ``conf.py`` file's ``html_theme`` setting:
.. code:: python
html_theme = "sphinx_rtd_theme"
Via git or download
-------------------
For more information, including a full example with localized strings enabled,
read the documentation on `installing the theme`_.
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", ]
.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
.. _installing the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html
Configuration
=============
You can configure different parts of the theme.
This theme is highly customizable on both the page level and on a global level.
To see all the possible configuration options, read the documentation on
`configuring the theme`_.
Project-wide configuration
--------------------------
.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html
The theme's project-wide options are defined in the ``sphinx_rtd_theme/theme.conf``
file of this repository, and can be defined in your project's ``conf.py`` via
``html_theme_options``. For example:
Contributing
============
.. code:: python
If you would like to help modify or translate the theme, you'll find more
information on contributing in our `contributing guide`_.
html_theme_options = {
'typekit_id': '',
'canonical_url': '',
'analytics_id': '',
'logo_only': False,
'display_version': True,
'prev_next_buttons_location': bottom,
'style_external_links': False,
# Toc options
'collapse_navigation': False,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False
}
The following options are available:
Base options
~~~~~~~~~~~~
* ``typekit_id`` This will let users specify a typekit id to use for displaying nicer fonts.
* ``canonical_url`` This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__
to let search engines know they should give higher ranking to latest version of the docs.
The url points to the root of the documentation and requires a trailing slash.
* ``analytics_id`` Change the Google Analytics ID that is included on pages.
* ``display_version`` With this disabled, the version number isn't shown at the top of the sidebar.
* ``prev_next_buttons_location`` can take the value ``bottom``, ``top``, ``both`` , or ``None``
and will display the "Next" and "Previous" buttons accordingly
* ``style_external_links`` Add an icon next to external links. Defaults to ``False``.
TOC Options
~~~~~~~~~~~
These effect how we display the Table of Contents in the side bar. You can read more about them here: http://www.sphinx-doc.org/en/stable/templating.html#toctree
* ``collapse_navigation`` With this enabled, you will lose the `[+]` drop downs next to each section in the sidebar. This is useful for _very large_ documents.
* ``sticky_navigation`` This causes the sidebar to scroll with the main page content as you scroll the page.
* ``includehidden`` Specifies if the sidebar includes toctrees marked with the `:hidden:` option
* ``titles_only`` If True, removes headers within a page from the sidebar.
Page-level configuration
------------------------
Pages support metadata that changes how the theme renders.
You can currently add the following:
* ``:github_url:`` This will force the "Edit on GitHub" to the configured URL
* ``:bitbucket_url:`` This will force the "Edit on Bitbucket" to the configured URL
* ``:gitlab_url:`` This will force the "Edit on GitLab" to the configured URL
Changelog
=========
master
------
* 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
* Include the lato italics font with the theme
* Fix padding on field lists
* Add setuptools entry point allowing to use ``sphinx_rtd_theme`` as
Sphinx ``html_theme`` directly.
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 decendant 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
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 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 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 will revert to static positioning. To disable the sticky nav
altogether 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 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.
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.
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.
Releasing the Theme
===================
When you release a new version,
you should do the following:
#. Bump the version in ``sphinx_rtd_theme/__init__.py`` – we try to follow `semver <http://semver.org/>`_, so be careful with breaking changes.
#. 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: ``python setup.py sdist bdist_wheel upload``.
#. In the ``readthedocs.org`` repo, edit the ``bower.json`` file to point at the correct version (``sphinx-rtd-theme": "https://github.com/rtfd/sphinx-rtd-theme.git#$NEW_VERSION"``).
#. In the ``readthedocs.org`` repo, run ``gulp build`` to update the distributed theme files.
TODO
====
* Separate some sass variables at the theme level so you can overwrite some basic colors.
.. _contributing guide: https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html
+10
View File
@@ -0,0 +1,10 @@
# How setup this file
# http://babel.pocoo.org/en/latest/setup.html
# this file description:
# http://babel.pocoo.org/en/latest/messages.html#extraction-method-mapping-and-configuration
# Extraction from Jinja2 HTML templates
[jinja2: **/**.html]
encoding = utf-8
ignore_tags = script,style
include_attrs = alt title summary placeholder
+20
View File
@@ -0,0 +1,20 @@
#!/usr/bin/env node
const package = require('../package.json');
// Sorry everyone, this is the closest we can get to commenting on package.json
// dependencies :(
if (package.devDependencies['bourbon-neat'] !== '~1.9') {
// Wyrm is not compatible with Neat 2.0+, and Neat 1.9 at least pins a
// node-sass version that doesn't require Python 2. The changes to Wyrm to
// support Neat 2.0+ are all fairly minor changes, but it deeply affects the
// grid system and might be more of a liability than an old release of Neat.
// See: https://github.com/readthedocs/sphinx_rtd_theme/pull/771
console.error(
'bourbon-neat 1.9 is required, Wyrm is not compatible with Neat 2.0+.'
);
console.error(
'The expected selector for the bourbon-neat dependency in package.json is "~1.9".'
);
process.exit(1);
}
-41
View File
@@ -1,41 +0,0 @@
{
"name": "sphinx-rtd-theme",
"version": "0.2.4",
"homepage": "https://github.com/rtfd/sphinx_rtd_theme",
"authors": [
"Dave Snider <dave.snider@gmail.com>"
],
"description": "Sphinx theme for readthedocs.org.",
"license": "MIT",
"main": [
"js/theme.js"
],
"ignore": [
"docs",
"demo_docs",
".gitignore",
".DS_Store",
".sass-cache*",
".bowerrc",
"bower.json",
"package.json",
"Gruntfile.js",
"node_modules",
"bower_components",
"test",
"tests",
"src"
],
"devDependencies": {
"wyrm": "~1.0.x"
},
"dependencies": {
"lato-googlefont": "*",
"robotoslab-googlefont": "*",
"inconsolata-googlefont": "*",
"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."
-48
View File
@@ -1,48 +0,0 @@
*********************
:mod:`test_py_module`
*********************
.. contents:: Table of Contents
.. automodule:: test_py_module.test
:members:
:private-members:
:special-members:
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`.
-258
View File
@@ -1,258 +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 executed 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
import 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',
'sphinxcontrib.httpdomain',
]
# 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 = '0.2.4'
# The full version, including alpha/beta/rc tags.
release = '0.2.4'
# 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
# 'titles_only': False # If True, it'll remove headers within a page from the sidebar.
}
# 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 = "static/logo-wordmark-light.svg"
# 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'
-30
View File
@@ -1,30 +0,0 @@
*****************************
Read the Docs Theme Demo Docs
*****************************
These documents are used to test and stress test the Read the Docs Theme.
:Last Reviewed: 2017-3-15
Contents
========
.. toctree::
:maxdepth: 3
:numbered:
:caption: Syntax Constructs
structure
demo
lists_tables
api
.. toctree::
:maxdepth: 3
:numbered:
:caption: This is an incredibly long caption for a long menu
long
You can also read the :ref:`genindex`
+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)
+7
View File
@@ -0,0 +1,7 @@
// Add debug actions to flyout menu
$(function () {
$("[data-toggle='rst-debug-badge']").on("click", function () {
$("[data-toggle='rst-versions']").toggleClass("rst-badge");
});
})
+55
View File
@@ -0,0 +1,55 @@
{%- extends "!layout.html" %}
{#-
This template exists as a way to implement a version menu without changing what
the theme normally renders the menu on local builds and on builds on Read the
Docs. This is for local testing purposes only.
#}
{%- block footer %}
{%- if not READTHEDOCS %}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Versions') }}">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>{{ _('Versions') }}</dt>
{%- if test_versions %}
{%- for version in test_versions %}
<dd><a href="#">{{ version }}</a></dd>
{%- endfor %}
{%- else %}
<dd><a href="#">latest</a></dd>
<dd><a href="#">1.0</a></dd>
<dd><a href="#">1.1</a></dd>
{%- endif %}
</dl>
<dl>
<dt>{{ _('Downloads') }}</dt>
<dd><a href="#">PDF</a></dd>
<dd><a href="#">ePub</a></dd>
<dd><a href="#">HTML</a></dd>
</dl>
<dl>
{#- Translators: The phrase "Read the Docs" is not translated #}
<dt>{{ _('On Read the Docs') }}</dt>
<dd>
<a href="#">{{ _('Project Home') }}</a>
</dd>
<dd>
<a href="#">{{ _('Builds') }}</a>
</dd>
</dl>
<dl>
<dt>Debug</dt>
<dd><a href="#" data-toggle="rst-debug-badge">Swap badge position</a></dd>
</dl>
</div>
</div>
{%- endif %}
{%- endblock %}
+337
View File
@@ -0,0 +1,337 @@
*********
Changelog
*********
Development version (|development_version|)
===========================================
.. |development_version| replace:: 1.0.0rc1
Incompatible Changes
--------------------
* The minimum supported python version is now 2.7 or 3.4 and greater (#1093)
* The minimum supported Sphinx version is now 1.6 (#1091)
Deprecated
----------
* Support for Sphinx's HTML4 writer is deprecated and will be removed in version 2.0 (#1091)
Features
--------
* Add support for Sphinx 4.x (#1123)
* Add support for Docutils 0.17 (#1185 and #1199)
* Fixed logo scaling on IE11 (#1183)
* Added support for logos as URLs (#1171)
* Align top and side navigation background colors on mobile (#1132)
* Added support for deep toc levels (#1089)
* Updated translations for Chinese, Dutch, Estonian, French, German, Italian,
Lithuanian, Persian, Polish, Portuguese, Russian, Spanish, Swedish, and
Turkish locales
A number of accessibility features were added in this release:
* Allow keyboard to toggle menu expansion (#1167)
* Allow keyboard to activate permalink (#1162)
* Show keyboard focus on buttons (#1161)
* Maintain aria-expanded along with .current in menu (#1151)
* Respect tab order for prev/next buttons (#1051)
Fixes
-----
* Updated Google analytics integration (#1129)
* Add classifier separation on Sphinx 2+ HTML4 writer (#1192)
* Added missing space char in footer (#1188)
* Fix navigation right padding on level2+ elements (#1068)
* Fix navigation expansion button sizes (#1067)
* Wrap inline literals (#1050)
* Fix aria labels (#1056)
* Don't toggle navigation terminal nodes (#1049)
Other Changes
-------------
* Update npm development dependencies (#1096)
* Don't require npm to build from source (#1039)
* Use regular toctree instead of toc for singlehtml builder (#507)
* Cleanup whitespace in templates (#1060)
v0.5.2
======
:Date: April 5, 2021
.. note:: This commit will not be in ``master``, but was branched directly off ``0.5.1`` to minimize issues.
The next full release will contain all PR's previously merged.
* Depend on docutils < 0.17 (#1113)
v0.5.1
======
:Date: January 4, 2021
Fixes
-----
* Set ``url_root`` properly on index (#1025)
* Do not load ``language_data.js`` in non-search pages (#1021)
* Hide the search box on any ``singlehtml`` like builder (#975)
* Fix ``vcs_pageview_mode`` template parameter (#1010)
* Mark nex/prev icons as aria-hidden (#1007)
* Use well-formed XML syntax (#1006)
* Footer: show both ``commit`` and ``last_updated`` if available (#897)
* Search page: don't show "edit on" links (#935)
New Features
------------
* New theme option to enable anonymous ip addresses when using Google Analytics (#889)
Other Changes
-------------
* The ``canonical_url`` option was deprecated in favor of Sphinx's ``html_baseurl`` (#1003)
* Add ``contentinfo`` block to ``footer.html`` template (#896)
* Make Copyright template match sphinx's basic (#933)
* Packaging: include ``bin/preinstall.js`` (#1005)
v0.5.0
======
:Date: Jun 17, 2020
Fixes
-----
* Fix bullet list spacing to respect simple/complex list styles
v0.5.0rc2
=========
:Date: June 5, 2020
Fixes
-----
* Fix issue with simple definition lists that was missed
* Change FOUT back to FOIT
* Fix several margin issues with lists, nested lists, and nested content
* Add colon back to field lists
v0.5.0rc1
=========
:Date: May 6, 2020
Fixes
-----
* Fix many styling issues that look different when using the Sphinx HTML5 writer
Other Changes
--------------
* Add the ``navigation`` template block around the navigation area.
* Added i18n support using Babel
* Added translations for 10 new languages
* Moved build system from Grunt and friends to Webpack
* Remove Modernizr, but keep html5shiv (#724, #525)
v0.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
+110
View File
@@ -0,0 +1,110 @@
# -*- coding: utf-8 -*-
import sys
import os
import re
# Prefer to use the version of the theme in this repo
# and not the installed version of the theme.
sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.abspath('./demo/'))
import sphinx_rtd_theme
from sphinx_rtd_theme import __version__ as theme_version
from sphinx_rtd_theme import __version_full__ as theme_version_full
from sphinx.locale import _
project = u'Read the Docs Sphinx Theme'
slug = re.sub(r'\W+', '-', project.lower())
version = theme_version
release = theme_version_full
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',
'sphinx_rtd_theme',
]
templates_path = ['_templates']
source_suffix = '.rst'
exclude_patterns = []
locale_dirs = ['locale/']
gettext_compact = False
master_doc = 'index'
suppress_warnings = ['image.nonlocal_uri']
pygments_style = 'default'
intersphinx_mapping = {
'rtd': ('https://docs.readthedocs.io/en/stable/', None),
'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
html_theme = 'sphinx_rtd_theme'
html_theme_options = {
'logo_only': True,
'navigation_depth': 5,
}
html_context = {}
if not 'READTHEDOCS' in os.environ:
html_static_path = ['_static/']
html_js_files = ['debug.js']
# Add fake versions for local QA of the menu
html_context['test_versions'] = list(map(
lambda x: str(x / 10),
range(1, 100)
))
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',),
),
]
)
+236
View File
@@ -0,0 +1,236 @@
*************
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 = {
'analytics_id': 'G-XXXXXXXXXX', # Provided by Google in your dashboard
'analytics_anonymize_ip': False,
'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
With this enabled, navigation entries are not expandable -- the ``[+]``
icons next to each entry are removed.
:type: boolean
:default: ``True``
.. note::
Setting :confval:`collapse_navigation` to ``False`` and using a high value
for :confval:`navigation_depth` on projects with many files and a deep file
structure can cause long compilation times and can result in HTML files that
are significantly larger in file size.
.. confval:: sticky_navigation
Scroll the navigation with the main page content as you scroll the page.
:type: boolean
:default: ``True``
.. confval:: navigation_depth
The maximum depth of the table of contents tree. Set
this to ``-1`` to allow unlimited depth.
:type: integer
:default: ``4``
.. confval:: includehidden
Specifies if the navigation includes hidden table(s) of contents -- that is,
any :rst:dir:`sphinx:toctree` directive that is marked with the ``:hidden:``
option.
:type: boolean
:default: ``True``
.. confval:: titles_only
When enabled, page subheadings are not included in the
navigation.
:type: boolean
:default: False
.. _table of contents configuration options: http://www.sphinx-doc.org/en/stable/templating.html#toctree
..
TODO
.
HTML context options
~~~~~~~~~~~~~~~~~~~~
Miscellaneous options
---------------------
.. confval:: analytics_id
If specified, Google Analytics' `gtag.js`_ is included in your pages.
Set the value to the ID provided to you by google (like ``UA-XXXXXXX`` or ``G-XXXXXXXXXX``).
:type: string
.. _gtag.js: https://developers.google.com/gtagjs
.. confval:: analytics_anonymize_ip
Anonymize visitor IP addresses in Google Analytics.
:type: boolean
:default: ``False``
.. confval:: canonical_url
This will specify a `canonical URL`_ meta link element to tell search
engines which URL should be ranked as the primary URL for your
documentation. This is important if you have multiple URLs that your
documentation is available through. The URL points to the root path of the
documentation and requires a trailing slash.
:type: URL
.. deprecated:: 0.6.0
Use :confval:`sphinx:html_baseurl` instead.
.. _canonical URL: https://en.wikipedia.org/wiki/Canonical_link_element
.. confval:: display_version
If ``True``, the version number is shown at the top of the sidebar.
:type: boolean
:default: ``True``
.. confval:: logo_only
Only display the logo image, do not display the project name at the top of
the sidebar
:type: boolean
:default: ``False``
.. confval:: prev_next_buttons_location
Location to display :guilabel:`Next` and :guilabel:`Previous` buttons. This
can be either ``bottom``, ``top``, ``both`` , or ``None``.
:type: string
:default: ``bottom``
.. confval:: style_external_links
Add an icon next to external links.
:type: boolean
:default: ``False``
.. confval:: vcs_pageview_mode
Changes how to view files when using ``display_github``, ``display_gitlab``,
etc. When using GitHub or GitLab this can be: ``blob`` (default), ``edit``,
or ``raw``. On Bitbucket, this can be either: ``view`` (default) or
``edit``.
:type: string
:default: ``blob`` or ``view``
.. confval:: style_nav_header_background
Changes the background of the search area in the navigation bar. The value
can be anything valid in a CSS `background` property.
:type: string
:default: ``#2980B9``
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.
+204
View File
@@ -0,0 +1,204 @@
************
Contributing
************
This project follows the Read the Docs :doc:`code of conduct
<rtd:code-of-conduct>`. If you are not familiar with our code of conduct policy,
take a minute to read the policy before starting with your first contribution.
Modifying the theme
===================
The styles for this theme use SASS_ and a custom CSS framework called Wyrm_. We
use Webpack_ and node-sass_ to build the CSS. Webpack_ is used to watch for
changes, rebuild the static assets, and rebuild the Sphinx demo documentation.
.. note::
The installation of Node is outside the scope of this documentation. You
will need Node version 10+ in order to make changes to this theme.
Set up your environment
-----------------------
#. Install Sphinx_ and documentation build dependencies.
.. code:: console
$ pip install -e '.[dev]'
#. Install Webpack_, node-sass_, and theme dependencies locally.
.. code:: console
$ npm install
Making changes
--------------
Changes to the theme can be compiled and tested with Webpack_:
.. code:: console
$ npm run dev
This script will do the following:
#. Install and update any dependencies.
#. Build the static CSS from SASS source files.
#. Build the demo documentation.
#. Watch for changes to the SASS files and documentation and rebuild everything
on any detected changes.
Alternatively, if you don't need to watch the files, the release build script
can be used to test built assets:
.. code:: console
$ npm run build
.. _Webpack: https://webpack.js.org/
.. _node-sass: https://github.com/sass/node-sass
.. _SASS: http://www.sass-lang.com
.. _Wyrm: http://www.github.com/snide/wyrm/
.. _Sphinx: http://www.sphinx-doc.org/en/stable/
Testing
=======
QA testing theme changes and pull requests is complex, due to backwards
compatibility.
The following cases need to be tested with changes to CSS or JavaScript:
* Multiple, modern browsers should be tested. We officially support back
to IE11 at the moment
* Multiple viewport sizes should be tested for changes. We support large,
tablet, and mobile viewport sizes
* We currently support both the Sphinx HTML4 writer and HTML5 writer. This makes
for some complex CSS selectors
* Multiple major versions of Sphinx should be tested. We currently support back
to Sphinx version ``1.6``
It's easiest to test combinations of dependency versions using ``tox``:
.. code:: console
% tox -e py3-sphinx34-html4
If the tests and build are successful, you can view the built documentation at
the directory noted by Sphinx:
.. code:: console
build succeeded, 10 warnings.
The HTML pages are in .tox/py3-sphinx34-html4/tmp/html.
___________________________ summary ___________________________
py3-sphinx34-html4: commands succeeded
congratulations :)
You can then open up this path with a series of browsers to test.
The best way to spot UI issues is to compare two or more builds. You can build
multiple ``tox`` environments, and open both up for comparison:
.. code:: console
% tox -e py3-sphinx34-html4
...
% tox -e py3-sphinx34-html5
...
% firefox .tox/py3-sphinx34-html4/tmp/html/index.html
% firefox .tox/py3-sphinx34-html5/tmp/html/index.html
You can also use a separate ``tox`` environment for building output to compare
against. All of the ``tox`` environments have an additional postfix, ``-qa``, to
allow building the same environment twice, without overwriting any files. In
this test scenario, you would build from a branch or tag before building the
same ``tox`` environment for the pull request branch you are testing.
For example, to test against the tag ``0.5.2``:
.. code:: console
% git checkout 0.5.2
% tox -e py3-sphinx34-html4-qa
...
% git checkout feature/example-pull-request
% tox -e py3-sphinx34-html4
...
% firefox .tox/py3-sphinx34-html4-qa/tmp/html/index.html
% firefox .tox/py3-sphinx34-html4/tmp/html/index.html
Currently, the most important environments to QA are:
.. This list is purposely shorter than what we describe above. If we test all of
the cases above, we'll be here all day. Python 3, HTML4/5 writer, and latest
minor of each major Sphinx release should give us enough work.
* ``py3-sphinx18-html4``
* ``py3-sphinx18-html5``
* ``py3-sphinx24-html4``
* ``py3-sphinx24-html5``
* ``py3-sphinx35-html4``
* ``py3-sphinx35-html5``
* ``py3-sphinx41-html4``
* ``py3-sphinx41-html5``
Translations
============
Translations are managed using `Transifex`_. You can join any of the existing
language teams or request a new language is added to the project. For more
information on our translation standards, see our docs on
:doc:`rtd:development/i18n`
Periodically, core team should update the translation files outside our normal
releases. Someone from the core team, with write access to Transifex, should run
the following:
.. code:: console
$ python setup.py update_translations
This will extract new messages, upload the messages to Transifex, and will
update our local translation files. Changes can be checked in to a branch and
put up for review.
.. _Transifex: https://www.transifex.com/readthedocs/sphinx-rtd-theme
Releasing the theme
===================
To release a new version of the theme, core team will take the following steps:
#. Bump the version by running ``bump2version [major|minor|patch|dev]``.
This will automatically increase the correct part(s) of the version number,
you do not need to specify the exact version number.
We follow `semver <http://semver.org/>`_ and `PEP440`_
(with regards to alpha release and development versions). The version
increment should reflect these releases and any potentially breaking changes.
#. New versions are by default ``alpha`` releases. If this is a release candidate,
run ``bump2version --allow-dirty release`` to update the release to an ``rc``
release. If this is a final release, run the command again.
#. Update the changelog (``docs/changelog.rst``) with the version information.
#. Run ``python setup.py update_translations`` to compile new translation files
and update Transifex.
#. Run ``python setup.py build_assets`` to rebuild all the theme assets and the Python
package.
#. Commit these changes.
#. Tag the release in git: ``git tag $NEW_VERSION``.
#. Push the tag to GitHub: ``git push --tags origin``.
#. Upload the package to PyPI:
.. code:: console
$ rm -rf dist/
$ python setup.py sdist bdist_wheel
$ twine upload --sign --identity security@readthedocs.org dist/*
#. Finally, open a new pull request updating the development release version to
the next patch by running ``bump2version patch``. Open a pull request with
this change.
.. _PEP440: https://www.python.org/dev/peps/pep-0440/
+139
View File
@@ -0,0 +1,139 @@
***************************************
API documentation and generated content
***************************************
.. contents:: Table of Contents
:mod:`test_py_module`
=====================
.. automodule:: test_py_module.test
:members:
:private-members:
:special-members:
C++ API
=======
.. cpp:type:: MyType
Some type
.. cpp:function:: const MyType Foo(const MyType bar)
Some function type thing
.. cpp:class:: template<typename T, std::size_t N> std::array
Some cpp class
.. cpp:member:: float Sphinx::version
The description of Sphinx::version.
.. cpp:var:: int version
The description of version.
.. cpp:type:: std::vector<int> List
The description of List type.
.. cpp:enum:: MyEnum
An unscoped enum.
.. cpp:enumerator:: A
.. cpp:enum-class:: MyScopedEnum
A scoped enum.
.. cpp:enumerator:: B
.. cpp:enum-struct:: protected MyScopedVisibilityEnum : std::underlying_type<MySpecificEnum>::type
A scoped enum with non-default visibility, and with a specified underlying type.
.. cpp:enumerator:: B
JavaScript API
==============
.. Copied from sphinx-doc/sphinx/tests/roots
.. js:module:: module_a.submodule
* Link to :js:class:`ModTopLevel`
.. js:class:: ModTopLevel
* Link to :js:meth:`mod_child_1`
* Link to :js:meth:`ModTopLevel.mod_child_1`
.. js:method:: ModTopLevel.mod_child_1
* Link to :js:meth:`mod_child_2`
.. js:method:: ModTopLevel.mod_child_2
* Link to :js:meth:`module_a.submodule.ModTopLevel.mod_child_1`
.. js:module:: module_b.submodule
* Link to :js:class:`ModTopLevel`
.. js:class:: ModNested
.. js:method:: nested_child_1
* Link to :js:meth:`nested_child_2`
.. js:method:: nested_child_2
* Link to :js:meth:`nested_child_1`
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`.
@@ -25,7 +25,7 @@ citation references ([12]_), substitution references (|example|), and _`inline h
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.
It will link you right to 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`;
@@ -49,6 +49,18 @@ Term : classifier
Term
Definition
I have no clue why the definition list below is classified as a different style
of definition list than the one above.
Is it the spaces in the term?
Maybe it was the multiple line paragraph
in the line below that caused this?
Is it the paragraph above the list maybe?
I guess a lot of these lists don't have leading paragraphs?
Is it everything all at once?
Who knows?!
Option Lists
------------
@@ -118,6 +130,28 @@ Field list
Bullet Lists
------------
..
Docutils supports two types of lists, "simple" and "complex". Complex lists
have item margins, simple lists do not.
https://docutils.sourceforge.io/sandbox/html4strict/data/simple-lists.html
Simple
^^^^^^
- A simple list.
- There are no margins between list items.
- Simple lists do not contain multiple paragraphs. That's a complex list.
- In the case of a nested list
- There are no margins between elements
- Still no margins
- Still no margins
Complex
^^^^^^^
- A bullet list
+ Nested bullet list.
@@ -138,6 +172,13 @@ Bullet Lists
- ``inline literall``
- ``inline literall``
- ``inline literall``
- This item has multiple paragraphs.
This item has multiple paragraphs.
- This item has multiple paragraphs.
This item has multiple paragraphs.
Second list level
^^^^^^^^^^^^^^^^^
@@ -150,7 +191,7 @@ Second list level
- 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
@@ -160,6 +201,11 @@ Second list level
- and another. `yahoo <http://www.yahoo.com>`_
- `yahoo <http://www.yahoo.com>`_
- ``hi``
- how about an admonition?
.. note::
This is a note nested in a list.
- and hehe
But deeper down the rabbit hole
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
+32
View File
@@ -0,0 +1,32 @@
.. include:: ../README.rst
.. toctree::
:caption: Theme Documentation
:maxdepth: 2
installing
configuring
contributing
.. toctree::
:maxdepth: 1
:hidden:
changelog
.. toctree::
:maxdepth: 2
:numbered:
:caption: Demo Documentation
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
+63
View File
@@ -0,0 +1,63 @@
************
Installation
************
Install the package (or add it to your ``requirements.txt`` file):
.. code:: console
$ pip install sphinx_rtd_theme
In your ``conf.py`` file:
.. code:: python
import sphinx_rtd_theme
extensions = [
...
'sphinx_rtd_theme',
]
html_theme = "sphinx_rtd_theme"
.. note::
Adding this theme as an extension is what enables localization of theme
strings in your translated output. If these strings are not translated in
your output, either we lack the localized strings for your locale, or you
are using an old version of the theme.
Via Git or Download
===================
.. warning::
Installing directly from the repo is deprecated.
Static assets won't be included in the repo in a future release.
Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into your documentation at
``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx
``conf.py`` file:
.. code:: python
html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]
Compatibility
=============
Python
------
``sphinx_rtd_theme`` requires Python 2.7 or Python 3.4 or greater.
Sphinx
------
``sphinx_rtd_theme`` depends on at least Sphinx 1.6 although,
we recommend at least Sphinx 2 to take advantage of the html5 writer.
The html4 writer is still supported however,
it is deprecated and support will be removed in the near future.
+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 @@
sphinx>=3.0
sphinxcontrib-httpdomain
+8162
View File
File diff suppressed because it is too large. Load diff
+40 -14
View File
@@ -1,20 +1,46 @@
{
"name": "sphinx_rtd_theme",
"version": "0.0.11",
"private": true,
"main": "js/theme.js",
"version": "1.0.0rc1",
"scripts": {
"dev": "webpack-dev-server --open --config webpack.dev.js",
"build": "webpack --config webpack.prod.js",
"preinstall": "bin/preinstall.js"
},
"repository": {
"type": "git",
"url": "https://github.com/readthedocs/sphinx_rtd_theme.git"
},
"author": "Read the Docs",
"license": "MIT",
"bugs": {
"url": "https://github.com/readthedocs/sphinx_rtd_theme/issues"
},
"homepage": "https://github.com/readthedocs/sphinx_rtd_theme",
"dependencies": {},
"devDependencies": {
"browserify": "^13.0.0",
"connect-livereload": "~0.6.0",
"grunt": "~1.0.1",
"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": "~0.8.0",
"grunt-contrib-watch": "~1.0.0",
"grunt-exec": "~1.0.1",
"grunt-open": "0.2.3",
"matchdep": "~1.0.1"
"bourbon": "~4.3",
"bourbon-neat": "~1.9",
"copy-webpack-plugin": "^5.1.2",
"css-loader": "^3.6.0",
"file-loader": "^3.0.1",
"font-awesome": "^4.7.0",
"html5shiv": "^3.7.3",
"imports-loader": "^0.8.0",
"jquery": "^3.6.0",
"lato-font": "^3.0.0",
"mini-css-extract-plugin": "^0.6.0",
"node-sass": "^4.13.1",
"optimize-css-assets-webpack-plugin": "^5.0.4",
"roboto-fontface": "^0.10.0",
"sass-loader": "^7.3.0",
"style-loader": "^0.23.1",
"webpack": "^4.46.0",
"webpack-cli": "^3.3.12",
"webpack-dev-server": "^3.11.2",
"webpack-merge": "^4.2.1",
"webpack-shell-plugin": "^0.5.0",
"webpack-watch-files-plugin": "^1.1.0",
"wyrm": "^1.0.9"
}
}
-48
View File
@@ -1,48 +0,0 @@
@font-face
font-family: 'Inconsolata'
font-style: normal
font-weight: 400
src: local('Inconsolata'), local('Inconsolata-Regular'), url(../fonts/Inconsolata-Regular.ttf) format('truetype')
@font-face
font-family: 'Inconsolata'
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'
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
font-weight: 700
src: local('Lato Bold'), local('Lato-Bold'), url(../fonts/Lato-Bold.ttf) format('truetype')
@font-face
font-family: 'Lato'
font-style: italic
font-weight: 400
src: local('Lato Italic'), local('Lato-Italic'), url(../fonts/Lato-Italic.ttf) format('truetype')
@font-face
font-family: 'Lato'
font-style: italic
font-weight: 700
src: local('Lato Bold Italic'), local('Lato-BoldItalic'), url(../fonts/Lato-BoldItalic.ttf) format('truetype')
@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')
@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')
+56
View File
@@ -1,2 +1,58 @@
[bumpversion]
current_version = 1.0.0rc1
commit = false
tag = false
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((?P<release>[a-z]+)(?P<dev>\d+))?
serialize =
{major}.{minor}.{patch}{release}{dev}
{major}.{minor}.{patch}
[bdist_wheel]
universal = 1
[extract_messages]
mapping_file = babel.cfg
output_file = sphinx_rtd_theme/locale/sphinx.pot
keywords = _ l_ lazy_gettext
add_comments = Translators:
[init_catalog]
domain = sphinx
input_file = sphinx_rtd_theme/locale/sphinx.pot
output_dir = sphinx_rtd_theme/locale/
[update_catalog]
domain = sphinx
input_file = sphinx_rtd_theme/locale/sphinx.pot
output_dir = sphinx_rtd_theme/locale/
[compile_catalog]
domain = sphinx
directory = sphinx_rtd_theme/locale/
[bumpversion:part:release]
optional_value = release
first_value = alpha
values =
alpha
rc
release
[bumpversion:part:dev]
first_value = 1
[bumpversion:file:setup.py]
[bumpversion:file:sphinx_rtd_theme/__init__.py]
[bumpversion:file:package.json]
search = "version": "{current_version}",
replace = "version": "{new_version}",
[bumpversion:file:package-lock.json]
search = "version": "{current_version}",
replace = "version": "{new_version}",
[bumpversion:file:docs/changelog.rst]
search = .. |development_version| replace:: {current_version}
replace = .. |development_version| replace:: {new_version}
+115 -13
View File
@@ -1,31 +1,113 @@
# -*- coding: utf-8 -*-
"""`sphinx_rtd_theme` lives on `Github`_.
.. _github: https://www.github.com/snide/sphinx_rtd_theme
"""
import distutils.cmd
import os
import subprocess
from io import open
from setuptools import setup
from sphinx_rtd_theme import __version__
class WebpackBuildCommand(distutils.cmd.Command):
description = "Generate static assets"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
if not 'CI' in os.environ and not 'TOX_ENV_NAME' in os.environ:
subprocess.run(['npm', 'install'], check=True)
subprocess.run(['node_modules/.bin/webpack', '--config', 'webpack.prod.js'], check=True)
class WebpackDevelopCommand(distutils.cmd.Command):
description = "Run Webpack dev server"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
subprocess.run(
["node_modules/.bin/webpack-dev-server", "--open", "--config", "webpack.dev.js"],
check=True
)
class UpdateTranslationsCommand(distutils.cmd.Command):
description = "Run all localization commands"
user_options = []
sub_commands = [
('extract_messages', None),
('update_catalog', None),
('transifex', None),
('compile_catalog', None),
]
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
for cmd_name in self.get_sub_commands():
self.run_command(cmd_name)
class TransifexCommand(distutils.cmd.Command):
description = "Update translation files through Transifex"
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
subprocess.run(['tx', 'push', '--source'], check=True)
subprocess.run(['tx', 'pull', '--mode', 'onlyreviewed', '-f', '-a'], check=True)
setup(
name='sphinx_rtd_theme',
version=__version__,
url='https://github.com/rtfd/sphinx_rtd_theme/',
version='1.0.0rc1',
url='https://github.com/readthedocs/sphinx_rtd_theme',
license='MIT',
author='Dave Snider',
author_email='dave.snider@gmail.com',
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(),
cmdclass={
'update_translations': UpdateTranslationsCommand,
'transifex': TransifexCommand,
'build_assets': WebpackBuildCommand,
'watch': WebpackDevelopCommand,
},
zip_safe=False,
packages=['sphinx_rtd_theme'],
package_data={'sphinx_rtd_theme': [
'theme.conf',
'*.html',
'static/css/*.css',
'static/css/fonts/*.*',
'static/js/*.js',
'static/font/*.*'
]},
include_package_data=True,
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
@@ -34,6 +116,21 @@ setup(
'sphinx_rtd_theme = sphinx_rtd_theme',
]
},
python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*',
install_requires=[
'sphinx>=1.6',
'docutils<0.18',
],
tests_require=[
'pytest',
],
extras_require={
'dev': [
'transifex-client',
'sphinxcontrib-httpdomain',
'bump2version',
],
},
classifiers=[
'Framework :: Sphinx',
'Framework :: Sphinx :: Theme',
@@ -44,12 +141,17 @@ setup(
'Intended Audience :: Developers',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Operating System :: OS Independent',
'Topic :: Documentation',
'Topic :: Software Development :: Documentation',
],
project_urls={
'Homepage': 'https://sphinx-rtd-theme.readthedocs.io/',
'Source Code': 'https://github.com/readthedocs/sphinx_rtd_theme',
'Issue Tracker': 'https://github.com/readthedocs/sphinx_rtd_theme/issues',
},
)
+48 -4
View File
@@ -1,19 +1,63 @@
"""Sphinx ReadTheDocs theme.
"""
Sphinx Read the Docs theme.
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
"""
from os import path
__version__ = '0.2.5b2'
from os import path
from sys import version_info as python_version
from sphinx import version_info as sphinx_version
from sphinx.locale import _
from sphinx.util.logging import getLogger
__version__ = '1.0.0rc1'
__version_full__ = __version__
logger = getLogger(__name__)
def get_html_theme_path():
"""Return list of HTML theme paths."""
cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
return cur_dir
def config_initiated(app, config):
theme_options = config.html_theme_options or {}
if theme_options.get('canonical_url'):
logger.warning(
_('The canonical_url option is deprecated, use the html_baseurl option from Sphinx instead.')
)
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
def setup(app):
if python_version[0] < 3:
logger.warning("Python 2 is deprecated with sphinx_rtd_theme, update to Python 3")
app.require_sphinx('1.6')
if sphinx_version <= (2, 0, 0):
logger.warning("Sphinx 1.x is deprecated with sphinx_rtd_theme, update to Sphinx 2.x or greater")
if not app.config.html_experimental_html5_writer:
logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme")
else:
if app.config.html4_writer:
logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme")
# Register the theme that can be referenced without adding a theme path
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
if sphinx_version >= (1, 8, 0):
# Add Sphinx message catalog for newer versions of Sphinx
# See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog
rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale')
app.add_message_catalog('sphinx', rtd_locale_path)
app.connect('config-inited', config_initiated)
# sphinx emits the permalink icon for headers, so choose one more in keeping with our theme
if sphinx_version >= (3, 5, 0):
app.config.html_permalinks_icon = "\uf0c1"
else:
app.config.html_add_permalinks = "\uf0c1"
return {'parallel_read_safe': True, 'parallel_write_safe': True}
+55 -60
View File
@@ -1,82 +1,77 @@
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}
{%- if meta is defined and meta is not none %}
{%- set check_meta = True %}
{%- else %}
{%- set check_meta = False %}
{%- endif %}
{% if page_source_suffix %}
{% set suffix = page_source_suffix %}
{% else %}
{% set suffix = source_suffix %}
{% endif %}
{%- if check_meta and 'github_url' in meta %}
{%- set display_github = True %}
{%- endif %}
{% if meta is defined and meta is not none %}
{% set check_meta = True %}
{% else %}
{% set check_meta = False %}
{% endif %}
{%- if check_meta and 'bitbucket_url' in meta %}
{%- set display_bitbucket = True %}
{%- endif %}
{% if check_meta and 'github_url' in meta %}
{% set display_github = True %}
{% endif %}
{%- if check_meta and 'gitlab_url' in meta %}
{%- set display_gitlab = 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">
{%- set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %}
{#- Translators: This is an ARIA section label for page links, including previous/next page link and links to GitHub/GitLab/etc. -#}
<div role="navigation" aria-label="{{ _('Page navigation') }}">
<ul class="wy-breadcrumbs">
{% block breadcrumbs %}
<li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> &raquo;</li>
{% for doc in parents %}
{%- block breadcrumbs %}
<li><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a> &raquo;</li>
{%- for doc in parents %}
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
{% endfor %}
{%- endfor %}
<li>{{ title }}</li>
{% endblock %}
{% block breadcrumbs_aside %}
{%- endblock %}
{%- block breadcrumbs_aside %}
<li class="wy-breadcrumbs-aside">
{% if hasdoc(pagename) %}
{% if display_github %}
{% if check_meta and 'github_url' in meta %}
{%- if hasdoc(pagename) and display_vcs_links %}
{%- 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 }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% endif %}
{% elif display_bitbucket %}
{% if check_meta and 'bitbucket_url' in meta %}
{%- else %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{%- endif %}
{%- elif display_bitbucket %}
{%- 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 }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
{% endif %}
{% elif display_gitlab %}
{% if check_meta and 'gitlab_url' in meta %}
{%- else %}
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}?mode={{ theme_vcs_pageview_mode or "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 }}/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 }}{{ suffix }}">{{ _('View page source') }}</a>
{% elif show_source and has_source and sourcename %}
{%- else %}
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
{%- endif %}
{%- elif show_source and source_url_prefix %}
<a href="{{ source_url_prefix }}{{ pagename }}{{ page_source_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>
{% endif %}
{% endif %}
{%- endif %}
{%- endif %}
</li>
{% endblock %}
{%- 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" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
{% endif %}
{%- if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
{#- Translators: This is an ARIA section label for sequential page links, such as previous and next page links. -#}
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="{{ _('Sequential page navigation') }}">
{%- if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
{%- endif %}
{%- if next %}
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
{%- endif %}
</div>
{% endif %}
{%- endif %}
<hr/>
</div>
+38 -28
View File
@@ -1,52 +1,62 @@
<footer>
{% 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" 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" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
{% endif %}
{%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
{#- Translators: This is an ARIA section label for the footer section of the page. -#}
<div class="rst-footer-buttons" role="navigation" aria-label="{{ _('Footer') }}">
{%- if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
{%- endif %}
{%- if next %}
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
{%- endif %}
</div>
{% endif %}
{%- endif %}
<hr/>
<div role="contentinfo">
{%- block contentinfo %}
<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 %}&#169; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
{%- else %}
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
{%- trans copyright=copyright|e %}&#169; Copyright {{ copyright }}.{% endtrans %}
{%- endif %}
{%- endif %}
{%- 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 %}
<span class="build">
{#- Translators: Build is a noun, not a verb -#}
{%- trans %}Build{% endtrans -%}
<a href="{{ build_url }}">{{ build_id }}</a>.
</span>
{%- elif commit %}
{% trans commit=commit %}
<span class="commit">
Revision <code>{{ commit }}</code>.
</span>
{% endtrans %}
{%- elif last_updated %}
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
<span class="commit">
{#- Translators: the phrase "revision" comes from Git, referring to a commit #}
{%- trans %}Revision{% endtrans %} <code>{{ commit }}</code>.
</span>
{%- endif %}
{%- if last_updated %}
<span class="lastupdated">
{%- trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
</span>
{%- endif -%}
</p>
{%- endblock %}
</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 %}.
{%- endif %}
{% if show_sphinx %}
{%- set sphinx_web = '<a href="https://www.sphinx-doc.org/">Sphinx</a>' %}
{%- set readthedocs_web = '<a href="https://readthedocs.org">Read the Docs</a>' %}
{#- Translators: the variable "sphinx_web" is a link to the Sphinx project documentation with the text "Sphinx" #}
{%- trans sphinx_web=sphinx_web, readthedocs_web=readthedocs_web %}Built with {{ sphinx_web }} using a{% endtrans %}
{#- Translators: "theme" refers to a theme for Sphinx, which alters the appearance of the generated documenation #}
<a href="https://github.com/readthedocs/sphinx_rtd_theme">{% trans %}theme{% endtrans %}</a>
{#- Translators: this is always used as "provided by Read the Docs", and should not imply Read the Docs is an author of the generated documentation. #}
{% trans %}provided by {{ readthedocs_web }}{% endtrans %}.
{% endif %}
{%- block extrafooter %} {% endblock %}
</footer>
+169 -136
View File
@@ -7,216 +7,249 @@
{%- set titlesuffix = "" %}
{%- endif %}
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
{%- set sphinx_writer = 'writer-html5' if html5_doctype else 'writer-html4' -%}
{# Build sphinx_version_info tuple from sphinx_version string in pure Jinja #}
{%- set (_ver_major, _ver_minor, _ver_bugfix) = sphinx_version.split('.') | map('int') -%}
{%- set sphinx_version_info = (_ver_major, _ver_minor, _ver_bugfix) -%}
<!DOCTYPE html>
<!--[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]-->
<html class="{{ sphinx_writer }}" lang="{{ lang_attr }}" >
<head>
<meta charset="utf-8">
{{ metatags }}
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{% block htmltitle %}
<meta charset="utf-8" />
{{- metatags }}
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
{%- block htmltitle %}
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
{% endblock %}
{%- endblock -%}
{# FAVICON #}
{% 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 %}
{# CSS #}
{# 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 %}
{#- CSS #}
{%- if sphinx_version_info < (4, 0) -%}
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
{% endif %}
<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 %}
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
{%- endif %}
{%- 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 %}
{% for cssfile in extra_css_files %}
{%- for cssfile in extra_css_files %}
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{% endfor %}
{%- endfor -%}
{#- FAVICON #}
{%- if favicon %}
{%- if sphinx_version_info < (4, 0) -%}
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
{%- else %}
<link rel="shortcut icon" href="{{ favicon_url }}"/>
{%- endif %}
{%- endif -%}
{#- CANONICAL URL (deprecated) #}
{%- if theme_canonical_url and not pageurl %}
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
{%- endif -%}
{#- CANONICAL URL #}
{%- if pageurl %}
<link rel="canonical" href="{{ pageurl|e }}" />
{%- endif -%}
{#- JAVASCRIPTS #}
{%- block scripts %}
<!--[if lt IE 9]>
<script src="{{ pathto('_static/js/html5shiv.min.js', 1) }}"></script>
<![endif]-->
{%- if not embedded %}
{# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
{%- if sphinx_version_info >= (1, 8) -%}
{%- if sphinx_version_info < (4, 0) -%}
<script id="documentation_options" data-url_root="{{ url_root }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
{%- endif -%}
{%- for scriptfile in script_files %}
{{ js_tag(scriptfile) }}
{%- endfor %}
{%- else %}
<script>
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 src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{%- endif %}
<script src="{{ pathto('_static/js/theme.js', 1) }}"></script>
{#- 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 %}
{%- endblock %}
{%- 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="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
</head>
<body class="wy-body-for-nav" role="document">
<body class="wy-body-for-nav">
{% block extrabody %} {% endblock %}
{%- block extrabody %} {% endblock %}
<div class="wy-grid-for-nav">
{# SIDE NAV, TOGGLES ON MOBILE #}
{#- SIDE NAV, TOGGLES ON MOBILE #}
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
{% block sidebartitle %}
<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 %}
{%- if logo and theme_logo_only %}
<a href="{{ pathto(master_doc) }}">
{% else %}
{%- else %}
<a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}
{% endif %}
{%- 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 %}
{%- if logo %}
{#- Not strictly valid HTML, but it's the only way to display/scale
it properly, without weird scripting or heaps of work
#}
{%- if sphinx_version_info < (4, 0) -%}
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="{{ _('Logo') }}"/>
{%- else %}
<img src="{{ logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
{%- endif %}
{%- endif %}
</a>
{% if theme_display_version %}
{%- if theme_display_version %}
{%- set nav_version = version %}
{% if READTHEDOCS and current_version %}
{%- if READTHEDOCS and current_version %}
{%- set nav_version = current_version %}
{% endif %}
{% if nav_version %}
{%- endif %}
{%- if nav_version %}
<div class="version">
{{ nav_version }}
</div>
{% endif %}
{% endif %}
{%- endif %}
{%- endif %}
{% include "searchbox.html" %}
{%- include "searchbox.html" %}
{% endblock %}
{%- 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 %}
{%- block navigation %}
{#- Translators: This is an ARIA section label for the main navigation menu -#}
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Navigation menu') }}">
{%- block menu %}
{%- set toctree = toctree(maxdepth=theme_navigation_depth|int,
collapse=theme_collapse_navigation|tobool,
includehidden=theme_includehidden|tobool,
titles_only=theme_titles_only|tobool) %}
{%- if toctree %}
{{ toctree }}
{%- else %}
<!-- Local TOC -->
<div class="local-toc">{{ toc }}</div>
{% endif %}
{% endblock %}
{%- endif %}
{%- endblock %}
</div>
{%- endblock %}
</div>
</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">
{% block mobile_nav %}
{#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
{#- Translators: This is an ARIA section label for the navigation menu that is visible when viewing the page on mobile devices -#}
<nav class="wy-nav-top" aria-label="{{ _('Mobile navigation menu') }}" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
{%- block mobile_nav %}
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
{% endblock %}
{%- endblock %}
</nav>
{# PAGE CONTENT #}
<div class="wy-nav-content">
{% if theme_style_external_links|tobool %}
{%- block content %}
{%- if theme_style_external_links|tobool %}
<div class="rst-content style-external-links">
{% else %}
{%- else %}
<div class="rst-content">
{% endif %}
{%- endif %}
{% include "breadcrumbs.html" %}
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
{%- block document %}
<div itemprop="articleBody">
{% block body %}{% endblock %}
</div>
<div class="articleComments">
{% block comments %}{% endblock %}
{% 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" %}
{% include "versions.html" -%}
{% if not embedded %}
<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 %}
{# 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|tobool %}
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
});
</script>
{% endif %}
{#- Do not conflict with RTD insertion of analytics script #}
{%- if not READTHEDOCS %}
{%- if theme_analytics_id %}
<!-- Theme Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id={{ theme_analytics_id }}"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', '{{ theme_analytics_id }}', {
'anonymize_ip': {{ 'true' if theme_analytics_anonymize_ip|tobool else 'false' }},
});
</script>
{%- endif %}
{%- endif %}
{%- block footer %} {% endblock %}
Binary file not shown.
@@ -0,0 +1,142 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Tom Kunze <transifex.com@tomabrafix.de>, 2019
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Tom Kunze <transifex.com@tomabrafix.de>, 2019\n"
"Language-Team: German (https://www.transifex.com/readthedocs/teams/101354/de/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: de\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Auf GitHub bearbeiten"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Auf Bitbucket bearbeiten"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Auf GitLab bearbeiten"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Quelltext anzeigen"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Zurück"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Weiter"
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Build"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Zuletzt aktualisiert am %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Erstellt mit %(sphinx_web)s mit einem"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "bereitgestellt von %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "%(docstitle)s durchsuchen"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "Über diese Dokumentation"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Index"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Suche"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Copyright"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr "Bitte aktiviere JavaScript, um die Suchfunktion zu nutzen."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Suchergebnisse"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"Es wurden keine mit deiner Suchanfrage übereinstimmenden Dokumente gefunden."
" Achte darauf, dass alle Wörter richtig geschrieben sind und dass genug "
"Kategorien ausgewählt sind."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Dokumentation durchsuchen"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Versionen"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "Auf Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Projektübersicht"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Builds"
#~ msgid "Docs"
#~ msgstr "Dokumentation"
#~ msgid "Free document hosting provided by"
#~ msgstr "Kostenloses Dokumentationen-Hosting zur Verfügung gestellt von"
Binary file not shown.
@@ -0,0 +1,201 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 15:43-0600\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
"Language-Team: en <LL@li.org>\n"
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
#. This is an ARIA section label for page links, including previous/next page
#. link and links to GitHub/GitLab/etc.
#: sphinx_rtd_theme/breadcrumbs.html:22
msgid "Page navigation"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr ""
#. This is an ARIA section label for sequential page links, such as previous
#. and next page links.
#: sphinx_rtd_theme/breadcrumbs.html:67
msgid "Sequential page navigation"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr ""
#. This is an ARIA section label for the footer section of the page.
#: sphinx_rtd_theme/footer.html:4
msgid "Footer"
msgstr ""
#: sphinx_rtd_theme/footer.html:21
#, python-format
msgid "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s."
msgstr ""
#: sphinx_rtd_theme/footer.html:23
#, python-format
msgid "&#169; Copyright %(copyright)s."
msgstr ""
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr ""
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr ""
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr ""
#. the variable "sphinx_web" is a link to the Sphinx project documentation with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr ""
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr ""
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr ""
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr ""
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr ""
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr ""
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr ""
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr ""
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr ""
#. This is an ARIA section label for the main navigation menu
#: sphinx_rtd_theme/layout.html:173
msgid "Navigation menu"
msgstr ""
#. This is an ARIA section label for the navigation menu that is visible when
#. viewing the page on mobile devices
#: sphinx_rtd_theme/layout.html:195
msgid "Mobile navigation menu"
msgstr ""
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr ""
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr ""
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words "
"are spelled correctly and that you've selected enough categories."
msgstr ""
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr ""
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr ""
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr ""
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr ""
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr ""
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr ""
#~ msgid "Docs"
#~ msgstr ""
#~ msgid "Free document hosting provided by"
#~ msgstr ""
#~ msgid "Documentation Home"
#~ msgstr ""
#~ msgid "Breadcrumbs"
#~ msgstr ""
#~ msgid "Main"
#~ msgstr ""
#~ msgid "Top"
#~ msgstr ""
Binary file not shown.
@@ -0,0 +1,163 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Anthony <aj@ohess.org>, 2019
# Leonardo J. Caballero G. <leonardocaballero@gmail.com>, 2020
# Radina Matic <radina.matic@gmail.com>, 2021
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Radina Matic <radina.matic@gmail.com>, 2021\n"
"Language-Team: Spanish (https://www.transifex.com/readthedocs/teams/101354/es/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: es\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Editar en GitHub"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Editar en Bitbucket"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Editar en GitLab"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Ver código fuente de la página"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Anterior"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Siguiente"
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Compilación"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "Revisión"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Actualizado por última vez el %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Compilado con %(sphinx_web)s usando un"
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "tema"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "proporcionado por %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "Buscar en %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "Sobre esta documentación"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Índice"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Búsqueda"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Derechos de autor"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logotipo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr ""
"Por favor, active JavaScript para habilitar la funcionalidad de búsqueda."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Resultados de la búsqueda"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"Su búsqueda no coincide con ningún documento. Por favor, asegúrese de que "
"todas las palabras estén correctamente escritas y que usted haya "
"seleccionado las suficientes categorías."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Buscar documentos"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Versiones"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "Descargas"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "En Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Página de Proyecto"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Compilaciones"
#~ msgid "Docs"
#~ msgstr "Documentos"
#~ msgid "Free document hosting provided by"
#~ msgstr "Alojamiento gratuito de documentación proporcionado por"
#~ msgid "Documentation Home"
#~ msgstr "Inicio de Documentación"
Binary file not shown.
@@ -0,0 +1,170 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Anthony <aj@ohess.org>, 2020
# Ivar Smolin <okul@linux.ee>, 2021
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Ivar Smolin <okul@linux.ee>, 2021\n"
"Language-Team: Estonian (https://www.transifex.com/readthedocs/teams/101354/et/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: et\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Muuda GitHubis"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Muuda Bitbucketis"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Muuda GitLabis"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Vaata lehe lähtekoodi"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Eelmine"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Järgmine"
#: sphinx_rtd_theme/footer.html:21
#, python-format
msgid "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s."
msgstr "&#169; <a href=\"%(path)s\">Autoriõigus</a> %(copyright)s."
#: sphinx_rtd_theme/footer.html:23
#, python-format
msgid "&#169; Copyright %(copyright)s."
msgstr "&#169; Autoriõigus %(copyright)s."
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Ehitus"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "Redaktsioon"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Viimati uuendatud %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Ehitatud %(sphinx_web)s'iga,"
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "kujundusteema"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "on loonud %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "Otsi dokumendist %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "Nende dokumentide kirjeldused"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Indeks"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Otsing"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Autoriõigus"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr "Otsimisfunktsiooni lubamiseks aktiveeri palun JavaScript"
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Otsingu tulemused"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"Sinu otsingule ei vastanud ükski dokument. Palun veendu, et kõik sisestatud "
"sõnad on õigesti kirjutatud ja sa oled valikud piisaval hulgal kategooriaid."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Otsi dokumente"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Versioonid"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "Allalaadimised"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "Saidil Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Projekti kodu"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Ehitused"
#~ msgid "Docs"
#~ msgstr "Dokumendid"
#~ msgid "Free document hosting provided by"
#~ msgstr "Dokumentatsiooni majutab tasuta"
#~ msgid "Documentation Home"
#~ msgstr "Dokumentatsiooni kodu"
Binary file not shown.
@@ -0,0 +1,160 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Anthony <aj@ohess.org>, 2021
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Anthony <aj@ohess.org>, 2021\n"
"Language-Team: Persian (Iran) (https://www.transifex.com/readthedocs/teams/101354/fa_IR/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: fa_IR\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "ویرایش در GitHub"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "ویرایش در Bitbucket"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "ویرایش در GitLab"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "نمایش متن منبع صفحه"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "پیشین"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "بعدی"
#: sphinx_rtd_theme/footer.html:21
#, python-format
msgid "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s."
msgstr "&#169; <a href=\"%(path)s\">حق انتشار</a> %(copyright)s."
#: sphinx_rtd_theme/footer.html:23
#, python-format
msgid "&#169; Copyright %(copyright)s."
msgstr "&#169; حق انتشار%(copyright)s."
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "ساخت"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "بازبینی"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "آخرین بروز رسانی در %(last_updated)s ."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "ساخته شده با %(sphinx_web)s"
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "پوسته"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "تهیّه شده با %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "جستجو در %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "درباره این مستندات"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "فهرست"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "جستجوی"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "کپی رایت"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "آرم"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr "لطفاً جاوا اسکریپت را فعّال کنید تا قابلیّت جستجو فعّال شود."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "نتایج جستجو"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"جستجوی شما با هیچ سندی مطابقت نداشت. لطفاً از درستی املای واژگان مطمئن شوید."
" هم‌چنین بررسی کنید آیا به اندازه کافی دسته بندی انتخاب کرده‌اید."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "جستجوی مستندات"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "نگارش‌ها"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "بارگیری‌ها"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "درباره‌ی خواندن مستندات"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "صفحه خانگی پروژه"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "ساخت‌ها"
Binary file not shown.
@@ -0,0 +1,162 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Anthony <aj@ohess.org>, 2020
# Nicolas Friedli <nicolas.friedli@gmail.com>, 2021
# Radina Matic <radina.matic@gmail.com>, 2021
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Radina Matic <radina.matic@gmail.com>, 2021\n"
"Language-Team: French (https://www.transifex.com/readthedocs/teams/101354/fr/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: fr\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Éditer sur GitHub"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Éditer sur Bitbucket"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Éditer sur GitLab"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Afficher la source de la page"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Précédent"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Suivant"
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Compilation"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "Révision"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Dernière mise à jour le %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Compilé avec %(sphinx_web)s en utilisant un"
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "thème"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "fourni par %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "Rechercher dans %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "À propos de cette documentation"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Index"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Rechercher"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Droits d'auteur"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr "Activez JavaScript pour accéder à la fonction de recherche."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Résultats de la recherche"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"Votre recherche ne correspond à aucun document. Assurez-vous que tous les "
"mots sont correctement orthographiés et que vous avez sélectionné "
"suffisamment de catégories."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Rechercher docs"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Versions"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "Téléchargements"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "À propos de Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Accueil du projet"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Compilations"
#~ msgid "Docs"
#~ msgstr "Docs"
#~ msgid "Free document hosting provided by"
#~ msgstr "Hébergement gratuit de documents fourni par"
#~ msgid "Documentation Home"
#~ msgstr "Accueil de la documentation"
Binary file not shown.
@@ -0,0 +1,171 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Anthony <aj@ohess.org>, 2021
# Maurizio Paglia <mpaglia0@gmail.com>, 2021
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Maurizio Paglia <mpaglia0@gmail.com>, 2021\n"
"Language-Team: Italian (https://www.transifex.com/readthedocs/teams/101354/it/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: it\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Modifica su GitHub"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Modifica su Bitbucket"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Modifica su GitLab"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Visualizza sorgente pagina"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Precedente"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Prossimo"
#: sphinx_rtd_theme/footer.html:21
#, python-format
msgid "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s."
msgstr "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s."
#: sphinx_rtd_theme/footer.html:23
#, python-format
msgid "&#169; Copyright %(copyright)s."
msgstr "&#169; Copyright %(copyright)s."
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Rev."
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "Revisione"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Ultimo aggiornamento il %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Realizzato con %(sphinx_web)s e il tema"
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "tema"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "fornito da %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "Cerca in %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "Nota sulla documentazione"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Indice"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Ricerca"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Copyright"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr "Devi attivare JavaScript per attivare la funzione di ricerca."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Risultati della ricerca"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"La tua ricerca non ha prodotto nessun risultato. Assicurati di aver scritto "
"correttamente tutti i termini cercati e di aver selezionato sufficienti "
"categorie."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Cerca documenti"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Versioni"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "Downloads"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "Riguardo Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Home progetto"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Rev."
#~ msgid "Docs"
#~ msgstr "Documenti"
#~ msgid "Free document hosting provided by"
#~ msgstr "L'archivio gratuito della documentazione è offerto da"
#~ msgid "Documentation Home"
#~ msgstr "Indice documenti"
Binary file not shown.
@@ -0,0 +1,169 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Tomas Straupis, 2021
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Tomas Straupis, 2021\n"
"Language-Team: Lithuanian (https://www.transifex.com/readthedocs/teams/101354/lt/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: lt\n"
"Plural-Forms: nplurals=4; plural=(n % 10 == 1 && (n % 100 > 19 || n % 100 < 11) ? 0 : (n % 10 >= 2 && n % 10 <=9) && (n % 100 > 19 || n % 100 < 11) ? 1 : n % 1 != 0 ? 2: 3);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Keisti GitHub'e"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Keisti Bitbucket'e"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Keisti GitLab'e"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Žiūrėti puslapio šaltinį"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Ankstesnis"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Kitas"
#: sphinx_rtd_theme/footer.html:21
#, python-format
msgid "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s."
msgstr "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s."
#: sphinx_rtd_theme/footer.html:23
#, python-format
msgid "&#169; Copyright %(copyright)s."
msgstr "&#169; Copyright %(copyright)s."
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Surinkimas"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "Versija"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Atnaujinta %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Surinkta su %(sphinx_web)s naudojant"
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "temą"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "pateiktą %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "Ieškoti %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "Apie šiuos dokumentus"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Indeksas"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Paieška"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Autorių teisės"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr "Prašome įjungti JavaScript, kad veiktų paieškos funkcionalumas."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Paieškos rezultatai"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"Jūsų paieškai neatitiko nei vienas dokumentas. Prašome įsitikinti, kad visi "
"žodžiai parašyti teisingai ir kad parinkote pakankamai kategorijų."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Ieškoti dokumentuose"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Versijos"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "Atsisiuntimai"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "Apie Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Projekto namai"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Surinkimai"
#~ msgid "Docs"
#~ msgstr "Dokumentai"
#~ msgid "Free document hosting provided by"
#~ msgstr "Nemokamą dokumentacijos talpinimą teikia"
#~ msgid "Documentation Home"
#~ msgstr "Dokumentacijos namai"
Binary file not shown.
@@ -0,0 +1,156 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Jesse Tan, 2019
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Jesse Tan, 2019\n"
"Language-Team: Dutch (https://www.transifex.com/readthedocs/teams/101354/nl/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: nl\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Bewerk op GitHub"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Bewerk op BitBucket"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Bewerk op GitLab"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Bekijk paginabron"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Vorige"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Volgende"
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Bouwresultaat"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "Revisie"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Laatste update op %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Gebouwd met %(sphinx_web)s met een"
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "thema"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "geleverd door %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "Zoek binnen %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "Over deze documenten"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Index"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Zoek"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Copyright"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr "Zet JavaScript aan om de zoekfunctie mogelijk te maken."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Zoekresultaten"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"Zoekpoging vond geen documenten. Zorg ervoor dat alle woorden correct zijn "
"gespeld en dat voldoende categorieën zijn geselecteerd."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Zoek in documentatie"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Versies"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "Downloads"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "Op Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Project Home"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Bouwresultaten"
#~ msgid "Docs"
#~ msgstr "Documentatie"
#~ msgid "Free document hosting provided by"
#~ msgstr "Gratis hosting voor documentatie verzorgd door"
Binary file not shown.
@@ -0,0 +1,143 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Michal Sniatala, 2021
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Michal Sniatala, 2021\n"
"Language-Team: Polish (https://www.transifex.com/readthedocs/teams/101354/pl/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: pl\n"
"Plural-Forms: nplurals=4; plural=(n==1 ? 0 : (n%10>=2 && n%10<=4) && (n%100<12 || n%100>14) ? 1 : n!=1 && (n%10>=0 && n%10<=1) || (n%10>=5 && n%10<=9) || (n%100>=12 && n%100<=14) ? 2 : 3);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Edytuj na GitHub"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Edytuj na Bitbucket"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Edytuj na GitLab"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Zobacz źródło strony"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Poprzedni"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Następny"
#: sphinx_rtd_theme/footer.html:21
#, python-format
msgid "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s."
msgstr "&#169; <a href=\"%(path)s\">Prawa zastrzeżone</a> %(copyright)s."
#: sphinx_rtd_theme/footer.html:23
#, python-format
msgid "&#169; Copyright %(copyright)s."
msgstr "&#169; Prawa zastrzeżone %(copyright)s."
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Ostatnia aktualizacja %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Zbudowano w %(sphinx_web)s używając"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "dostarczone przez %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "Szukaj w %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "O tych dokumentach"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Indeks"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Szukaj"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Prawa zastrzeżone"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr ""
"Proszę aktywować obsługę JavaScript, aby włączyć funkcję wyszukiwania."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Wyniki wyszukiwania"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"Nie znaleziono szukanej frazy. Upewnij się, że wszystkie słowa są napisane "
"poprawnie i że wybrałeś wystarczającą liczbę kategorii."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Szukaj"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Wersje"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "Pobrania"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "Na Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Strona projektu"
#~ msgid "Free document hosting provided by"
#~ msgstr "Bezpłatny hosting dokumentacji zapewniony przez"
#~ msgid "Documentation Home"
#~ msgstr "Strona dokumentacji"
Binary file not shown.
@@ -0,0 +1,172 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Wellington Uemura <wellingtonuemura@gmail.com>, 2021
# Rafael Fontenelle <rffontenelle@gmail.com>, 2021
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Rafael Fontenelle <rffontenelle@gmail.com>, 2021\n"
"Language-Team: Portuguese (Brazil) (https://www.transifex.com/readthedocs/teams/101354/pt_BR/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: pt_BR\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Editar no GitHub"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Editar no Bitbucket"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Editar no GitLab"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Ver código-fonte da página"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Anterior"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Próximo"
#: sphinx_rtd_theme/footer.html:21
#, python-format
msgid "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s."
msgstr "&#169; <a href=\"%(path)s\">Direitos autorais</a> %(copyright)s."
#: sphinx_rtd_theme/footer.html:23
#, python-format
msgid "&#169; Copyright %(copyright)s."
msgstr "&#169; Direitos autorais %(copyright)s."
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Compilação"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "Revisão"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Última atualização em %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Compilado com %(sphinx_web)s usando um"
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "tema"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "fornecido por %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "Pesquisar em %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "Sobre esses documentos"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Índice"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Pesquisar"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Copyright"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr ""
"Por favor, ative JavaScript para habilitar a funcionalidade de pesquisa."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Resultados da pesquisa"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"A sua pesquisa não encontrou nenhum documento correspondente. Verifique se "
"todas as palavras estão escritas corretamente e se você selecionou "
"categorias suficientes."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Pesquisar documentos"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Versões"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "Downloads"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "No Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Página inicial"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Compilações"
#~ msgid "Docs"
#~ msgstr "Docs"
#~ msgid "Free document hosting provided by"
#~ msgstr "Hospedagem de documentos livres fornecida por"
#~ msgid "Documentation Home"
#~ msgstr "Página inicial da documentação"
Binary file not shown.
@@ -0,0 +1,157 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Dmitry Shachnev <mitya57@gmail.com>, 2019
# lvv83 <vlozhkin83@gmail.com>, 2019
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: lvv83 <vlozhkin83@gmail.com>, 2019\n"
"Language-Team: Russian (https://www.transifex.com/readthedocs/teams/101354/ru/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: ru\n"
"Plural-Forms: nplurals=4; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<12 || n%100>14) ? 1 : n%10==0 || (n%10>=5 && n%10<=9) || (n%100>=11 && n%100<=14)? 2 : 3);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Редактировать на GitHub"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Редактировать на BitBucket"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Редактировать на GitLab"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Просмотреть исходный код страницы"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Предыдущая"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Следующая"
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Сборка"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "Ревизия"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Последний раз обновлено %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Собрано при помощи %(sphinx_web)s с использованием"
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "темы,"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "предоставленной %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "Поиск в %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "Об этих документах"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Алфавитный указатель"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Поиск"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Авторские права"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Логотип"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr "Активируйте JavaScript, чтобы использовать функционал поиска."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Результаты поиска"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"По Вашему запросу не найдено результатов. Пожалуйста, проверьте, что все "
"слова написаны правильно, и Вы выбрали нужные категории."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Поиск в документации"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Версии"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "Загрузки"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "На Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Домашняя страница проекта"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Сборки"
#~ msgid "Docs"
#~ msgstr "Документация"
#~ msgid "Free document hosting provided by"
#~ msgstr "Бесплатный хостинг документов, предоставленный"
+182
View File
@@ -0,0 +1,182 @@
# Translations template for sphinx_rtd_theme.
# Copyright (C) 2021 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2021.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 1.0.0rc1\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
#. This is an ARIA section label for page links, including previous/next page
#. link and links to GitHub/GitLab/etc.
#: sphinx_rtd_theme/breadcrumbs.html:22
msgid "Page navigation"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr ""
#. This is an ARIA section label for sequential page links, such as previous
#. and next page links.
#: sphinx_rtd_theme/breadcrumbs.html:67
msgid "Sequential page navigation"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr ""
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr ""
#. This is an ARIA section label for the footer section of the page.
#: sphinx_rtd_theme/footer.html:4
msgid "Footer"
msgstr ""
#: sphinx_rtd_theme/footer.html:21
#, python-format
msgid "&#169; <a href=\"%(path)s\">Copyright</a> %(copyright)s."
msgstr ""
#: sphinx_rtd_theme/footer.html:23
#, python-format
msgid "&#169; Copyright %(copyright)s."
msgstr ""
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr ""
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr ""
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr ""
#. the variable "sphinx_web" is a link to the Sphinx project documentation with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr ""
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr ""
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr ""
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr ""
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr ""
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr ""
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr ""
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr ""
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr ""
#. This is an ARIA section label for the main navigation menu
#: sphinx_rtd_theme/layout.html:173
msgid "Navigation menu"
msgstr ""
#. This is an ARIA section label for the navigation menu that is visible when
#. viewing the page on mobile devices
#: sphinx_rtd_theme/layout.html:195
msgid "Mobile navigation menu"
msgstr ""
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr ""
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr ""
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words "
"are spelled correctly and that you've selected enough categories."
msgstr ""
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr ""
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr ""
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr ""
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr ""
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr ""
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr ""
Binary file not shown.
@@ -0,0 +1,160 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Daniel Holmberg <daniel.holmberg97@gmail.com>, 2020
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: Daniel Holmberg <daniel.holmberg97@gmail.com>, 2020\n"
"Language-Team: Swedish (https://www.transifex.com/readthedocs/teams/101354/sv/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: sv\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "Editera på GitHub"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Editera på Bitbucket"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "Editera på GitLab"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Visa sidkälla"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Tillbaka"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Nästa"
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Bygg"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "Ändra"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Senast uppdaterad %(last_updated)s."
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "Gjord med %(sphinx_web)s med hjälp av"
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "tema"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "erhållet av %(readthedocs_web)s"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "Sök i %(docstitle)s"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "Om dessa dokument"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Index"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Sök"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Upphovsrätt"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr ""
"Var vänlig och aktivera JavaScript för att möjliggöra sökfunktionaliteten."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Sökresultat"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"Din sökning gav inga träffar. Var vänlig och se till att alla ord är rätt "
"stavade och att du har valt tillräckligt många kategorier."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Sök i dokumentationen"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Versioner"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "Nerladdningar"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "På Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Projekt Hem"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Versioner"
#~ msgid "Docs"
#~ msgstr "Dokumentation"
#~ msgid "Free document hosting provided by"
#~ msgstr "Gratis dokumentations hysning erhållen av"
#~ msgid "Documentation Home"
#~ msgstr "Dokumentation Hem"
Binary file not shown.
@@ -0,0 +1,152 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# BouRock, 2020
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: BouRock, 2020\n"
"Language-Team: Turkish (https://www.transifex.com/readthedocs/teams/101354/tr/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: tr\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "GitHub'da Düzenle"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "Bitbucket'ta Düzenle"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "GitLab'ta Düzenle"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "Sayfa kaynağını görüntüle"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "Önceki"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "Sonraki"
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "Oluşturma"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "Gözden geçirme"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "Son olarak %(last_updated)s tarihinde güncellendi."
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "tema"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "kullanılarak %(readthedocs_web)s tarafından sağlanmasıyla oluşturuldu"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "%(docstitle)s içinde ara"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "Bu belgeler hakkında"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "Dizin"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "Arama"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "Telif hakkı"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr ""
"Arama işlevselliğini etkinleştirmek için lütfen JavaScript'i etkinleştirin."
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "Arama Sonuçları"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr ""
"Aramanız hiçbir belgeyle eşleşmedi. Lütfen tüm kelimelerin doğru "
"yazıldığından ve yeterli kategori seçtiğinizden emin olun."
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "Belgeleri arayın"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "Sürümler"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "İndirmeler"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "Read the Docs Üzerinde"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "Proje Ana Sayfa"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "Oluşturmalar"
#~ msgid "Docs"
#~ msgstr "Belgeler"
#~ msgid "Free document hosting provided by"
#~ msgstr "Ücretsiz belge barındırmayı sağlayan"
#~ msgid "Documentation Home"
#~ msgstr "Belgelendirme Giriş"
Binary file not shown.
@@ -0,0 +1,158 @@
# English translations for sphinx_rtd_theme.
# Copyright (C) 2019 ORGANIZATION
# This file is distributed under the same license as the sphinx_rtd_theme
# project.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
#
# Translators:
# Anthony <aj@ohess.org>, 2020
# 王赛 <wangsai@bootcss.com>, 2020
#
msgid ""
msgstr ""
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2021-08-17 10:02-0600\n"
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
"Last-Translator: 王赛 <wangsai@bootcss.com>, 2020\n"
"Language-Team: Chinese (China) (https://www.transifex.com/readthedocs/teams/101354/zh_CN/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Language: zh_CN\n"
"Plural-Forms: nplurals=1; plural=0;\n"
#: sphinx_rtd_theme/breadcrumbs.html:37 sphinx_rtd_theme/breadcrumbs.html:39
msgid "Edit on GitHub"
msgstr "在 GitHub 上修改"
#: sphinx_rtd_theme/breadcrumbs.html:44 sphinx_rtd_theme/breadcrumbs.html:46
msgid "Edit on Bitbucket"
msgstr "在 Bitbucket 上修改"
#: sphinx_rtd_theme/breadcrumbs.html:51 sphinx_rtd_theme/breadcrumbs.html:53
msgid "Edit on GitLab"
msgstr "在 GitLab 上修改"
#: sphinx_rtd_theme/breadcrumbs.html:56 sphinx_rtd_theme/breadcrumbs.html:58
msgid "View page source"
msgstr "查看页面源码"
#: sphinx_rtd_theme/breadcrumbs.html:69 sphinx_rtd_theme/footer.html:6
msgid "Previous"
msgstr "上一页"
#: sphinx_rtd_theme/breadcrumbs.html:72 sphinx_rtd_theme/footer.html:9
msgid "Next"
msgstr "下一页"
#. Build is a noun, not a verb
#: sphinx_rtd_theme/footer.html:30
msgid "Build"
msgstr "构建"
#. the phrase "revision" comes from Git, referring to a commit
#: sphinx_rtd_theme/footer.html:36
msgid "Revision"
msgstr "修订"
#: sphinx_rtd_theme/footer.html:41
#, python-format
msgid "Last updated on %(last_updated)s."
msgstr "最后更新时间 %(last_updated)s。"
#. the variable "sphinx_web" is a link to the Sphinx project documentation
#. with
#. the text "Sphinx"
#: sphinx_rtd_theme/footer.html:53
#, python-format
msgid "Built with %(sphinx_web)s using a"
msgstr "利用 %(sphinx_web)s 构建,使用了 "
#. "theme" refers to a theme for Sphinx, which alters the appearance of the
#. generated documenation
#: sphinx_rtd_theme/footer.html:55
msgid "theme"
msgstr "主题"
#. this is always used as "provided by Read the Docs", and should not imply
#. Read the Docs is an author of the generated documentation.
#: sphinx_rtd_theme/footer.html:57
#, python-format
msgid "provided by %(readthedocs_web)s"
msgstr "由 %(readthedocs_web)s开发"
#: sphinx_rtd_theme/layout.html:97
#, python-format
msgid "Search within %(docstitle)s"
msgstr "在 %(docstitle)s中搜索"
#: sphinx_rtd_theme/layout.html:105
msgid "About these documents"
msgstr "关于此文档"
#: sphinx_rtd_theme/layout.html:108
msgid "Index"
msgstr "索引"
#: sphinx_rtd_theme/layout.html:111 sphinx_rtd_theme/search.html:11
msgid "Search"
msgstr "搜索"
#: sphinx_rtd_theme/layout.html:114
msgid "Copyright"
msgstr "版权所有"
#: sphinx_rtd_theme/layout.html:147 sphinx_rtd_theme/layout.html:149
msgid "Logo"
msgstr "Logo"
#: sphinx_rtd_theme/search.html:31
msgid "Please activate JavaScript to enable the search functionality."
msgstr "请启用 JavaScript 以便使用搜索功能"
#. Search is a noun, not a verb
#: sphinx_rtd_theme/search.html:39
msgid "Search Results"
msgstr "搜索结果"
#: sphinx_rtd_theme/search.html:41
msgid ""
"Your search did not match any documents. Please make sure that all words are"
" spelled correctly and that you've selected enough categories."
msgstr "您的搜索没有匹配到任何文档。请确保所有单词拼写正确,并选择了足够多的类别。"
#: sphinx_rtd_theme/searchbox.html:4
msgid "Search docs"
msgstr "在文档中搜索"
#: sphinx_rtd_theme/versions.html:3 sphinx_rtd_theme/versions.html:11
msgid "Versions"
msgstr "版本列表"
#: sphinx_rtd_theme/versions.html:17
msgid "Downloads"
msgstr "下载链接"
#. The phrase "Read the Docs" is not translated
#: sphinx_rtd_theme/versions.html:24
msgid "On Read the Docs"
msgstr "托管于 Read the Docs"
#: sphinx_rtd_theme/versions.html:26
msgid "Project Home"
msgstr "项目首页"
#: sphinx_rtd_theme/versions.html:29
msgid "Builds"
msgstr "构建"
#~ msgid "Docs"
#~ msgstr "文档"
#~ msgid "Free document hosting provided by"
#~ msgstr "此文档免费托管于"
#~ msgid "Documentation Home"
#~ msgstr "文档首页"
+11 -5
View File
@@ -5,31 +5,37 @@
Template for the search page.
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
:license: BSD, see https://github.com/sphinx-doc/sphinx/blob/master/LICENSE for details.
#}
{%- extends "layout.html" %}
{% set title = _('Search') %}
{% set script_files = script_files + ['_static/searchtools.js'] %}
{% set display_vcs_links = False %}
{%- block scripts %}
{{ super() }}
<script src="{{ pathto('_static/searchtools.js', 1) }}"></script>
<script src="{{ pathto('_static/language_data.js', 1) }}"></script>
{%- endblock %}
{% block footer %}
<script type="text/javascript">
<script>
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>
<script id="searchindexloader"></script>
{{ super() }}
{% endblock %}
{% block body %}
<noscript>
<div id="fallback" class="admonition warning">
<p class="last">
{% trans %}Please activate JavaScript to enable the search
{% trans trimmed %}Please activate JavaScript to enable the search
functionality.{% endtrans %}
</p>
</div>
</noscript>
{% if search_performed %}
{# Translators: Search is a noun, not a verb #}
<h2>{{ _('Search Results') }}</h2>
{% if not search_results %}
<p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
+1 -1
View File
@@ -1,4 +1,4 @@
{%- if builder != 'singlehtml' %}
{%- if 'singlehtml' not in builder %}
<div role="search">
<form id="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get">
<input type="text" name="q" placeholder="{{ _('Search docs') }}" />
+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("../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: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}}
/*# sourceMappingURL=badge_only.css.map */
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.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}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.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:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #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 .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.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,sCAAwB,EAC7B,EAAG,EAAE,8PAG2D,ECftE,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,EEuC+B,MAAyB,EFtC7D,SAAU,EAAE,MAAkC,EAC9C,SAAU,EAAE,iBAAiC,EAC7C,UAAW,EEkDyB,sDAA2D,EFjD/F,MAAO,EC+E6B,EAAG,ED9EvC,cAAC,EACC,IAAK,EEkC6B,MAAK,EFjCvC,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,EEX6B,MAAM,EL4F1C,IAAK,EAAE,AAAC,EACR,iFAAS,EAEP,MAAO,EAAE,IAAK,EACd,MAAO,EAAE,CAAE,EACb,uCAAO,EACL,IAAK,EAAE,GAAI,EGrFX,qCAAG,EACD,IAAK,EEmB2B,MAAyB,EFlB3D,0CAAQ,EACN,IAAK,EAAE,GAAI,EACb,4CAAU,EACR,IAAK,EAAE,GAAI,EACb,iDAAiB,EACf,eAAgB,ECQgB,MAAI,EDPpC,IAAK,EEO2B,GAAM,EFNxC,wDAAwB,EACtB,eAAgB,EEsBgB,MAAO,EFrBvC,IAAK,ECzB2B,GAAI,ED0BxC,yCAA8B,EAC5B,MAAO,EAAE,IAAK,EAChB,gCAAmB,EACjB,QAAS,EAAE,EAAG,EACd,MAAO,EAAE,GAAqB,EAC9B,IAAK,EEJ6B,GAAY,EFK9C,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,EEZyB,MAAyB,EFa7D,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",
"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"
}
Loaded 100 of 140 files, more files were not shown because too many files have changed in this diff. Show more