* Fix typo
* Lock file changes after running 'npm install --lockfile-version 1' w/ Node 14
* Format file prior to change
* Remove the html5shiv JS package & all references to it
* Remove the copy-webpack-plugin JS package as no longer used
---------
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
* Remove Sphinx<5 compatibility
Since 2.0 we do not support Sphinx<5.
* Always use `writer-html5`
Since 2.0 HTML4 writer is not supported.
* Use `css_tag` helper to inject CSS files
* Revert "Remove Sphinx<5 compatibility"
Keep `sphinx_version_info`. It will be required.
This reverts commit 3afbed2950.
* Set `data-content_root` for Sphinx >= 7.2
Copied from https://github.com/readthedocs/sphinx_rtd_theme/pull/1507
* Default value for `DISPLAY` and `--new-tab`
* Visual test with Firefox and tox
Allows developer to run
```
tox -e py310-sphinx72-firefox
```
This will run the tests and open a Firefox after building the demo site
showing the `demo/demo.html` page on it.
Then, you can also run:
```
tox -e py310-sphinx61-firefox
```
and compare the visual differences.
Idea copied from #1388Closes#1388
* Update sphinx_rtd_theme/layout.html
Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
* Remove code from merge conflict
* Revert a mistake done on merging
* Update CSS logic again
* Minor refactor to undocumented `extra_css_files` option
---------
Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
* Remove pytest warnings
Ignore deprecations on Sphinx 9.0 that comes from readthedocs-sphinx-ext and use
`findall()` instead of `.traverse()` as suggested by docutils.
* We can't ignore a warning from Sphinx 9.0
We are testing in older versions where this exception is not defined.
The deprecation warning we are seeing here is not related to `sphinx_rtd_theme`
but with `readthedocs-sphinx-ext` because at:
13edf78bab/readthedocs_ext/readthedocs.py (L118-L122)
In any case, we will stop using that Sphinx extension at some point.
* Fix#1522: fix attribute error if css is str
* Revert "Fix #1522: fix attribute error if css is str"
This reverts commit b22a77f35a.
* Use `css_tag` only for standard CSS files from Sphinx
... and keep using the custom `link` HTML tag for CSS files included via the
HTML theme option `extra_css_files`.
* Normalize template variables
---------
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
Co-authored-by: Anthony Johnson <aj@ohess.org>
* Visual test with Firefox and tox
Allows developer to run
```
tox -e py310-sphinx72-firefox
```
This will run the tests and open a Firefox after building the demo site
showing the `demo/demo.html` page on it.
Then, you can also run:
```
tox -e py310-sphinx61-firefox
```
and compare the visual differences.
Idea copied from #1388Closes#1388
* Default value for `DISPLAY` and `--new-tab`
* Simplify the idea :)
* Remove instructions "encouraging" to install directly from git
* Update changelog: Add reminder that people should not install directly from git
* Update docs/changelog.rst
---------
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
* 2.0 milestone: drop supported versions
The new policy is:
- Python >=3.6
- Sphinx >= 5
- HTML4 and HTML5 writer
- docutils >= 0.14, < 0.19
* Update roadmap after discussion
By the beginning of 2024 we should support newer Sphinx versions and HTML5 only.
* Remove Python 2.7 from CircleCI
* Run only supported versions on Python 3.11
* Update with feedback from review
* Update documentation to match our support
* Add Sphinx 6.2 that was missing
* Update tox/circleci to work
* Revert tox command
* Drop support for HTML4 and keep `-qa` testing
- drop support for HTML4 on 2.0
- keep `-qa` TOX environment to be able to compare feature branches
- emit `logger.errors` on Python 2 and html_writer4=True
- require Sphinx >= 5.0
- remove logic for old Sphinx versions
* Update Tox and CircleCI
* Update contributing page to match our plans
---------
Co-authored-by: Anthony Johnson <aj@ohess.org>
* Allow Sphinx 7
* Also build theme docs with Sphinx 7
* Add more tests cases on tox.ini
* Increase the Sphinx version for the docs
---------
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
* Changelog for 1.2.2
* 1.2.2rc1
* Build: Fix bug that reads out container id from previous run
* Update package-lock to match release
* Bump to 1.2.2 final
* Remove version logic on sphinxcontrib-jquery, require >=4,<5
* Bump to Sphinx 6.1.x
* Remove testing for Sphinx 1.7, sphinxcontrib-jquery 4.x blocks it
* Adds a bit of basic styling for `:menuselection:`
* Rebuild CSS
* Remove docs demo, there was one already exactly below :)
* Make menuselection color same as guilabel
* Update assets for https://github.com/readthedocs/sphinx_rtd_theme/pull/1426
* Typo in recommended pinning
The paragraph above recommends "less than the next major version". But the example says `<=`. Make them match
* Update development.rst
* Add a call to add_js_files since it doesn't happen when loading extension from theme https://github.com/sphinx-contrib/jquery/issues/23
* Avoid importing from sphinxcontrib.jquery in __init__
* Add reference to issue
* Drop development version header from changelog
This makes just as much sense as a point release header, and won't
require any special attention when we're cutting a release.
* Bump release 1.2.0
* Update package lock
* Sphinx 6: Use logo_url instead of logo
* Handle removal of favicon template context + refactor display of logo and link so it's easier to see what belongs to <4.0 and what is >=4.0
* Adds a favicon to the demo
* Import condensed version logic @agjohnson
* Update sphinx_rtd_theme/layout.html
Co-authored-by: Anthony <aj@ohess.org>
Co-authored-by: Anthony <aj@ohess.org>
* support Python 3.11 with Sphinx 5.3+
* Update tox.ini
Co-authored-by: Michael R. Crusoe <1330696+mr-c@users.noreply.github.com>
Co-authored-by: Benjamin Balder Bach <benjamin@overtag.dk>
Co-authored-by: Benjamin Balder Bach <benjaoming@gmail.com>
* Allow Sphinx version 6 and add dependency for sphinxcontrib-jquery
* Adds Sphinx 6.0b2 to Tox test matrix
* Adds Sphinx 6 to relevant Circle CI pipelines
* Build docs with Sphinx 6.0b2
* Use stable Sphinx 6.0.0
* Add changelog entry for docutils 0.18 support
* Update docs/changelog.rst
Co-authored-by: Anthony <aj@ohess.org>
Co-authored-by: Anthony <aj@ohess.org>
* Add docutils 0.18 citation/footnote support using CSS grid
This is a fix for #1322 that continues our pattern for HTML5 support
using CSS grids, introduced for support for docutils < 0.17 HTML5
support.
* Add lots of backreferences to a footnote
* Drop brackets from footnote/citation links
The brackets seem to be another docutils addition.
* Tune grid display for Sphinx 4 and 5
Backrefs have a new styling that drops a lot of punctuation
* Bump dependency on docutils to < 0.19
* Small tweak to footnote backrefs row span
We don't want to use too large a value here, as some browsers might make
explicit rows for us. We can't target -1 because the row count is
implicit.
* Revert some new styling and use nonbreaking backrefs for now
* Downgrade tox
* Use before pseudo class to break up backrefs consistently