Commit Graph

1214 Commits

Author SHA1 Message Date
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 Carlisle
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,
e886cc2171/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 f5289bb699
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 Fischer
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
Nils K
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