Commit Graph
1338 Commits
Author SHA1 Message Date
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) 0.5.1 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' 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 0.5.0rc2 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