Skip to content

Commit

Permalink
Nicer styles for <kbd>
Browse files Browse the repository at this point in the history
It seems readthedocs#677 never actually got merged into master

Apply suggestions from code review

Co-authored-by: Jesse Tan <jessetan@users.noreply.github.com>

Add development version back to docs

Update to next development release after 1.0.0

For now, we'll be a bugfix release at 1.0.1 but do anticipate we'll be
adding features this release and will get to 1.1.0.

Requires readthedocs#1230

Use consistent indentation in src/sass/_theme_rst.sass (readthedocs#1234)

Fix typos (readthedocs#1291)

Fix CircleCI config

Build with Node 14 installed through orbs.

Fixes readthedocs#1275

Fix SASS syntax errors from readthedocs#967

This introduced syntax errors that were not picked up in review, the
`:not()` psuedo selector can't lead a selector in SASS.

Pin Jinja to pre-3.1 release

Ignore asdf configuration

Bump to a valid version scheme, bump node-sass for Node 14 support

Docker configuration for dev environment

Remove some text @agjohnson

First updates migrating to docker-compose

Removes Makefile + double FROM in Dockerfile

Fix node.js error in docker runtime, speed up build by not copying the entire context

Use static setuptools metadata

Add rule to remove double margin inside dl's

Remove double margin from all dl's not just last

Remove double margin from all dl's not just last

Add a demo with Python types (regression test for readthedocs#1196), rebuild theme.js

Bump to a valid version scheme, bump node-sass for Node 14 support

Do not bump the version in auto-maintained file package-lock.json

Adds wheel and a command to package bdist_wheel + sdist

Build everything one step at a time

Make note about releasing `package-lock.json`

Do not build the python package in this step

Fixes the fix from readthedocs#1315 - the CSS selector was wrong

Rebuild theme.css with "Fix <kbd> CSS selector readthedocs#1320"

Wrapping up the Docker work, using docker cp again in order to copy assets out of containers

Tune kbd selectors

Exclude option lists from selectors for kbd styling.

Revert change to JS package

This matches the version number in the Python package, and allows
bumpversion to continue working. We can revisit changing this version
later, but currently this version will never be updated again, as
bumpversion will not match this string anymore.

Fixes readthedocs#1326

Fix a wrong example, replace non-existing `Body Elements` with `References`

Add an upper bound for when Sphinx 6 is released

Fix readthedocs#1078: Citation not styled properly (readthedocs#1080)

* Fix readthedocs#1078: Citation not styled properly

Turns out our demo docs werent being rendered by sphinx as citations so this may have slipped though the sphinx 2 fixes.

I updated the demo docs and included the need style fixes.

* Group citations and footnotes

* Build Assets

* Build theme.css with "Fix readthedocs#1078: Citation not styled properly readthedocs#1080"

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Fixes readthedocs#289: Inconsistent table typography sizing (readthedocs#1215)

* Fix table typography inconsistent sizing

* Remove rule duplication

* Remove <ol> and fix build

* Build new theme.css for readthedocs#1215

* Add an example rendering with paragraphs inside tables

* build theme.css for readthedocs#1215

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Build matrix fixes (readthedocs#1338)

* Add new Sphinx versions to tox test matrix, but do not allow docutils >= 0.17 on Sphinx>=4.3

* Stop py2 and py27 support from sphinxlatest because of build breakage

* Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)

* tox.ini config: Ensure that we are getting the expected Sphinx version

Add Python 3.10 support (readthedocs#1334)

* Add Python 3.10 support

* Add new Sphinx versions to tox test matrix, but do not allow docutils >= 0.17 on Sphinx>=4.3

* Stop py2 and py27 support from sphinxlatest because of build breakage

* Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)

* tox.ini config: Ensure that we are getting the expected Sphinx version

* Set sphinx versions for Python 3.10

Fix definition lists inside api docs (readthedocs#1084)

* Fix definition lists inside api docs

This is similar to readthedocs#1080 (and is needed to fix citations in the demo here)

Fixes readthedocs#1052

* Build Assets

* Build Assets 2

* New build of theme.css and theme.js

* Regenerate theme.css for readthedocs#1084

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Remove font-smoothing (readthedocs#1094)

* Remove font-smoothing

This is a non standard css feature and is not supported on many platforms. And has been removed from the css standard specification.
It is advized to not use it according to MDN along with many other guides on the internet.

* rebuild theme.css and badge_only.css for readthedocs#1094

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

CSS: Add overflow-wrap to links inside paragraphs (readthedocs#1193)

* Add overflow-wrap to links inside paragraphs

* Add regression test for very long URLs

* Build theme.css for readthedocs#1193

* build theme.css for readthedocs#1193

* Build theme.css for readthedocs#1193

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Update Breadcrumb Styles (readthedocs#1073)

* Update Breadcrumb Styles

- Fixes extra padding to the left/right
- Used slash instead of >>
- Make literalls match other link style
- Adds demo docs for testing

* Update comment

* Update src/sass/_theme_breadcrumbs.sass

Co-authored-by: Ana Costa <anacosta.xl@gmail.com>

* Build theme.css for readthedocs#1073

* Build theme.css for readthedocs#1073

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Ana Costa <anacosta.xl@gmail.com>

Fixup a wrong merge conflict resolution from readthedocs#1321 (readthedocs#1335)

* Fixup a wrong merge conflict resolution from readthedocs#1321

* Add python_requires again to setup.cfg

Add sphinx 5.2 to test matrix (readthedocs#1348)

Update layout.html to support a sphinx version that is not three-integers (readthedocs#1345)

* Update layout.html to support a sphinx version that is not three-integers. Useful for sphinx==5.2.0.post0

* Apply suggestions from code review

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

* No reason to only have the first three elements from the sphinx version

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Benjamin Balder Bach <benjamin@overtag.dk>

Translation updates: Pull translations from transifex, push new sources (readthedocs#1354)

Adds changelog for 1.1.0alpha1 (readthedocs#1353)

* Adds changelog for 1.1.0alpha1

* Update docs/changelog.rst

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>

Additions to Tox and Circle CI matrix (readthedocs#1349)

* Refines tox matrix, adds a new target "sphinxdev" that can test the latest upstream development branch

* Adds missing tox environments in circle ci config

* Remove odd undefined py2 and py3 tox environments

Move context logic for layout.html to jinja (readthedocs#1356)

* Revert "Update layout.html to support a sphinx version that is not three-integers (readthedocs#1345)"

This reverts commit 45cf218.

* Always slice list before unpacking so number of elements is expected range

`map` filter returns a generator that needs to run through the `list` filter before slicing

* Let's keep it a 3-tuple but always set 3rd component to -1 -- in case a project was unpacking 3 values

Release 1.1.0b1 + 1.1.0b2 (bump versions with bump2version) (readthedocs#1352)

* Bump to 1.1.0 using bump2version

* Use PEP440 and make it a beta, i.e. "1.1.0b1"

* Auto-generated package-lock.json but with version bumps

* Bump to 1.1.0b2, rebuild assets

Remove Jinja2 dependency (readthedocs#1360)

* Remove Jinja2 dependency, inherited from Sphinx + handled in external environments

* Remove mentioning of Jinja2 dependency change

* Add Jinja2<3.1 dependecy to affected tox environments

Release 1.1.0b3 (readthedocs#1361)

* Update __init__.py because it wasn't updated by previous bump2version

* Add some comments about docker mechanisms that are disturbing release workflow

* Bump to version 1.1.0b3

* Revert "Bump to 1.1.0b2, rebuild assets"

This reverts commit 615eb52.

* Add changelog entry for readthedocs#1073

* Changelog entry for readthedocs#1193

Bump to version 1.1.0 (readthedocs#1367)

Do not overflow object cross references (readthedocs#1369)

* Do not overflow object cross references

* Rebuild theme for readthedocs#1369

* Adds a demo for the regression

* Mock sphinx-automodapi for now, but we can use it soon

* we can replace sphinx-automodapi demo entirely with autosummary since it uses this under the hood

* We need a python 2.7 compliant test module. Add a short-term workaround until this is removed in 2.0.

* Add comment about the terrible tox workaround

* Use a less hacky way of conditional autosummary in demo API docs

- Use `only` directive for conditional reST instead
- Drops 1.6 from our text matrix, it was deprecated in 1.0 release.
  There were issues with the conditional directive only on 1.6 for some
  reason.

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Anthony Johnson <aj@ohess.org>

Bugfix release 1.1.1 (readthedocs#1371)

* Bugfix release 1.1.1

* Release package updates

* Package lock
* Translations

Bump development version after 1.1.1 release (readthedocs#1372)

Update versioning docs to be explicit about our versioning workflow (readthedocs#1373)

Docs: Add upgrade instructions and simplify conf.py (readthedocs#1365)

* Docs: Clean up several broken cross-references

* Adds a section about upgrading the theme and add navigation structure to installation guide

* Add a reference from Changelog to "How to upgrade"

* Also don't import sphinx_rtd_theme in the theme's own docs/conf.py

* Remove trailing linebreaks

* Update docs/installing.rst

Co-authored-by: Anthony <aj@ohess.org>

* Apply suggestions from code review

Co-authored-by: Anthony <aj@ohess.org>

* Update docs/installing.rst

* Replace guidance with reference to Reproducible Builds

* Build link into sentence

* Update the tip about using build logs and the need to pin the theme for older projects

* Remove tip box for Read the Docs users re: @agjohnson's request

Co-authored-by: Anthony <aj@ohess.org>

New release of sphinxcontrib-httpdomain==1.8.1 broke tests (readthedocs#1383)

* New release of sphinxcontrib-httpdomain==1.8.1 broke tests

* Remove sphinxcontrib-httpdomain

Eager upgrade of all dependencies in docker development environment (readthedocs#1350)

* Do an eager upgrade of all dependencies in docker development environment

* Adds a comment about installation of deps and upgrade strategy

Added aria-label to search box input field. (readthedocs#1380)

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>

Added hidden text for home link in the breadcrumbs. (readthedocs#1384)

* Added hidden text for home link in breadcrumbs.

* Update breadcrumbs.html

* Update breadcrumbs.html

Add docutils 0.18 citation/footnote support using CSS grid (readthedocs#1381)

* Add docutils 0.18 citation/footnote support using CSS grid

This is a fix for readthedocs#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

Add changelog entry for docutils 0.18 support (readthedocs#1389)

* 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>

Release 1.2.0rc1 (readthedocs#1391)

* Bump to 1.2.0alpha1

* bump 2 1.2.0rc1

* Update package-lock.json from nmp audit

* Sync translations from Transifex (no changes found though)

Allow Sphinx version 6 and add dependency for sphinxcontrib-jquery (readthedocs#1385)

* 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

support Python 3.11 with Sphinx 5.3+ (readthedocs#1395)

* 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>

sphinx-rtd-theme will automatically enable sphinxcontrib-jquery (readthedocs#1399)

1.2.0rc2 (readthedocs#1397)

* Bump to 1.2.0rc2, add changelog entry on Sphinx 6

* Pull translations (no changes)

* loosen sphinx 6 pinning

Updates to package-lock.json for 1.2.0rc2 (readthedocs#1400)

Updates to package-lock.json

Sphinx 6: Use logo_url instead of logo (readthedocs#1405)

* 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>

Release 1.2.0rc3 (readthedocs#1414)

* Bump version to 1.2.0rc3

* Update changelog with more entries and known issues

* Update package-lock

Do not use sphinxcontrib-jquery 3.0.0 but anticipate a fixed release (readthedocs#1421)

* Do not use sphinxcontrib-jquery but anticipate a fixed release

* Only require sphinxcontrib-jquery on Python 3 (Sphinx 6 isn't released for 2.7)

release 1.2.0rc4 (readthedocs#1430)

* Bump to 1.2.0rc4

* Update changelog

* Update translations

* Chinese (Taiwan) was also a new addition

Release 1.2.0 (readthedocs#1432)

* 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

Bump to next alpha for development (readthedocs#1433)

fixed type-o in note on automatic index generation (readthedocs#1458)

Add a call to add_js_files (sphinxcontrib.query) (readthedocs#1448)

* Add a call to add_js_files since it doesn't happen when loading extension from theme sphinx-contrib/jquery#23

* Avoid importing from sphinxcontrib.jquery in __init__

* Add reference to issue

Docs: Typo in recommended pinning (readthedocs#1476)

* Typo in recommended pinning

The paragraph above recommends "less than the next major version". But the example says `<=`. Make them match

* Update development.rst

Release 1.2.1 (readthedocs#1474)

* Run bump2version

* Add changelog

Contributing updates (readthedocs#1478)

* Add reminder to pull from remote

* Sign git tags

:menuselection: style (readthedocs#1426)

* 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 readthedocs#1426

Remove version logic on sphinxcontrib-jquery, require >=4,<5 (readthedocs#1446)

* 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

Release 1.2.2 (readthedocs#1484)

* 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

Add Sphinx 7 support (readthedocs#1464)

* 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>

Release 1.3.0rc1 (readthedocs#1494)

* Release 1.3.0rc1

* Update lock file

1.3.0rc2 (readthedocs#1495)

The repo is normally bumped to the next up potential release so it
doesn't conflict with the current release.

Release 1.3.0 (readthedocs#1509)

Bump the RC to final
  • Loading branch information
Blendify authored and khancyr committed Oct 31, 2023
1 parent e3b5ee8 commit a7fc70d
Show file tree
Hide file tree
Showing 85 changed files with 2,824 additions and 1,444 deletions.
32 changes: 30 additions & 2 deletions .circleci/config.yml
@@ -1,5 +1,8 @@
version: 2.1

orbs:
node: circleci/node@5.0.2

commands:
run-tox:
description: "Run tox"
Expand All @@ -8,15 +11,17 @@ commands:
type: string
sphinx-version:
type: string
default: "16,17,18,20,21,22,23,24,30,31,32,33,34,35,40,41,latest"
default: "18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,43,44,45,50,51,52,latest"
steps:
- checkout
- run: pip install --user tox
- run: pip install --user tox~=3.27
- run: tox -e "<<parameters.version>>-sphinx{<<parameters.sphinx-version>>}"
run-build:
description: "Ensure built assets are up to date"
steps:
- checkout
- node/install:
node-version: '14.20'
- run: npm ci
- run: npm run build
- run:
Expand All @@ -41,6 +46,7 @@ jobs:
steps:
- run-tox:
version: py27
sphinx-version: "17,18"
py36:
docker:
- image: 'cimg/python:3.6'
Expand All @@ -59,18 +65,40 @@ jobs:
steps:
- run-tox:
version: py38
sphinx-version: "18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,43,44,45,50,51,52,60,latest"
py39:
docker:
- image: 'cimg/python:3.9'
steps:
- run-tox:
version: py39
sphinx-version: "18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,43,44,45,50,51,52,60,latest"
py310:
docker:
- image: 'cimg/python:3.10'
steps:
- run-tox:
version: py310
sphinx-version: "42,43,44,45,50,51,52,53,60,latest"
py311:
docker:
- image: 'cimg/python:3.11'
steps:
- run-tox:
version: py311
sphinx-version: "53,60,latest"

workflows:
version: 2
tests:
jobs:
- build
- py311:
requires:
- build
- py310:
requires:
- build
- py39:
requires:
- build
Expand Down
7 changes: 6 additions & 1 deletion .gitignore
Expand Up @@ -21,6 +21,11 @@ sphinx_rtd_theme/static/fonts/Lato/
sphinx_rtd_theme/static/fonts/RobotoSlab/
.python-version
.node-version
.tool-versions
.nvmrc
sphinx_rtd_theme/static/js/html5shiv.min.js
sphinx_rtd_theme/static/js/html5shiv-printshiv.min.js
.nvmrc
.direnv/
.envrc
# Used for dockerized builds
.container_id
3 changes: 2 additions & 1 deletion .tx/config
@@ -1,9 +1,10 @@
[sphinx-rtd-theme.sphinx-rtd-theme]
file_filter = sphinx_rtd_theme/locale/<lang>/LC_MESSAGES/sphinx.po
minimum_perc = 60
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

60 changes: 60 additions & 0 deletions Dockerfile
@@ -0,0 +1,60 @@
# This implicitely includes Python 3.10
FROM node:14-alpine

# Do not use --update since that will also fetch the
# latest node-current package
# 'make' is needed for building documentation
RUN apk add npm make py3-pip py3-wheel

# Add an extra verification that we have the right node
# because the above caused issues
RUN node -v && node -v | grep -q v14 &&\
python3 --version && python3 --version | grep -q "3.10"

RUN pip install pip --upgrade

RUN mkdir -p /project/src/ &&\
mkdir -p /project/docs/build/ &&\
mkdir -p /project-minimal-copy/sphinx_rtd_theme &&\
touch /project-minimal-copy/sphinx_rtd_theme/__init__.py

# This is the main working directory where node_modules
# gets built. During runtime, it's mixed with directories
# from an external environment through a bind mount
WORKDIR /project

# Copy files necessary to run "npm install" and save
# installed packages in the docker image (makes the runtime
# so much faster)
COPY package.json /project/
COPY bin/preinstall.js /project/bin/preinstall.js

RUN cd /project

# It matters that the node environment is installed into the same
# folder, i.e. /project where we will run the environment from
# TODO: We don't want to update package-lock.json here, we
# should use npm ci instead
RUN npm install --package-lock-only &&\
npm audit fix &&\
npm install

# This is strictly speaking not necessary, just makes
# running the container faster...
# Install dependencies, then uninstall project itself
COPY setup.py README.rst /project-minimal-copy/
RUN cd /project-minimal-copy &&\
pip install ".[dev]" &&\
/usr/bin/yes | pip uninstall sphinx_rtd_theme


# Copy in files that we need to run the project. These files
# will not be mounted into the runtime from external environment
# so we copy them during build.
COPY webpack.common.js webpack.dev.js webpack.prod.js /project/

# Copy in the entrypoint and we're done
COPY docker-entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh

ENTRYPOINT ["/entrypoint.sh"]
19 changes: 19 additions & 0 deletions Makefile
@@ -0,0 +1,19 @@
SHELL := /bin/bash
CWD := $(shell cd -P -- '$(shell dirname -- "$0")' && pwd -P)

docker-images:
docker-compose build

docker-npm-build:
rm -f .container_id
docker-compose run -d sphinx_rtd_theme build > .container_id
sleep 1s
docker container wait "$(shell cat .container_id)"
docker cp "$(shell cat .container_id):/project/sphinx_rtd_theme" .
docker cp "$(shell cat .container_id):/project/package-lock.json" .
@echo "Done building"

docker-npm-dev:
docker-compose run sphinx_rtd_theme dev

docker-build-all: docker-images docker-npm-build
26 changes: 26 additions & 0 deletions docker-compose.yaml
@@ -0,0 +1,26 @@
version: "3.2"
services:

sphinx_rtd_theme:
build: .
volumes:
- type: "bind"
source: "./"
target: "/project-readonly"
read_only: true
- type: "volume"
target: "/project-readonly/sphinx_rtd_theme.egg-info"
- type: "bind"
source: "./src"
target: "/project/src"
read_only: true
- type: "bind"
source: "./docs"
target: "/project/docs"
read_only: false #todo: fix this
- type: "volume"
target: "/project/docs/_build"

network_mode: host
ports:
- "1919:1919"
25 changes: 25 additions & 0 deletions docker-entrypoint.sh
@@ -0,0 +1,25 @@
#!/bin/sh

# Update latest Python dependencies in case they have changed
# Notice that we are using the 'eager' strategy
# This should only be relevant to development environments where
# the theme is being used. For purposes of "production" or
# building the sdist/wheel, installing dependencies should not
# affect the outcome.
cd /project-readonly
pip install --upgrade --upgrade-strategy eager -e ".[dev]"

# This helps a potential permission issue, but might be removed
# pending some more investigation of docker host file system
# permissions in the bind mount
# npm cache clean --force
# npm install

cd /project

# TODO: This is a bad approach, it copies from the image which
# may be outdated to the current git tree
cp -r /project-readonly/sphinx_rtd_theme .

echo "Going to invoke: npm run $@"
npm run $@
141 changes: 141 additions & 0 deletions docs/changelog.rst
Expand Up @@ -2,6 +2,147 @@
Changelog
*********

.. seealso:: :ref:`howto_upgrade`

.. |theme_version| replace:: 1.3.0

.. _release-1.3.0:

1.3.0
=====

Added
-----

* Relaxed requirements to include Sphinx release ``7.0``

.. _release-1.2.2:

1.2.2
=====

Fixes
-----

* Require `sphinxcontrib-jquery>=4,<5` (#1446)

Added
-----

* Styling for `:menuselection:` (#1426)


.. _release-1.2.1:

1.2.1
=====

Fixes
-----

* Load jQuery correctly when using latest sphinxcontrib-jquery release (#1448)


.. _release-1.2.0:

1.2.0
=====

Dependency changes
------------------

* docutils 0.18 is supported. (#1381)
* Sphinx 6 support added
* Added ``sphinxcontrib-jquery`` as a dependency (#1385 #1421)
* Python 3.11 is officially supported and tested. (#1395)
* Python 3.4 and 3.5 are officially not supported (#1395)

Changes
-------

* Automatically use ``sphinxcontrib-jquery`` in Sphinx 6+ (#1399)
* Use new context vars ``logo_url``, ``favicon_url`` and ``root_doc`` when available (#1405)
* Translations updated: French, Hungarian, Croatian
* Translations added: Danish, Chinese (Taiwan)

Note for users of Sphinx<4
--------------------------

If you cannot use a more recent Sphinx release,
you should at least ensure you are using the most recent release for your major version.
Currently, these are Sphinx `1.8.6` and `2.4.5`.
Older releases may install unsupported versions of several dependencies, including Jinja2 and docutils.

Known issues
------------

In some cases, jQuery is not loaded with Sphinx 6 on Read the Docs.
Workaround: You need to add ``sphinx_rtd_theme`` to ``extensions`` in your ``conf.py``.
See `readthedocs.org issue #9654`_ for updates.

.. _readthedocs.org issue #9654: https://github.com/readthedocs/readthedocs.org/pull/9654


.. _release-1.1.1:

1.1.1
=====

Fixes
-----

* Fix wrapping bug on cross references (#1368)

.. _release-1.1.0:

1.1.0
=====

Dependency Changes
------------------

Many documentation projects depend on ``sphinx-rtd-theme`` without specifying a version of the theme (unpinned) while also depending on unpinned versions of Sphinx. The latest version of ``sphinx-rtd-theme`` ideally always supports the latest version of Sphinx, but this is now guaranteed.

This release adds upper bounds to direct dependencies ``Sphinx`` and ``docutils`` which will safeguard from mixing with possibly incompatible future versions of Sphinx & docutils.

* Sphinx versions supported: 1.6 to 5.2.x
* ``Sphinx<6`` (#1332)
* ``docutils<0.18`` (unchanged, but will be bumped in an upcoming release)


Features
--------

* Nicer styles for <kbd> (#967)
* New styling for breadcrumbs (#1073)


Fixes
-----

* Suffixes in Sphinx version caused build errors (#1345)
* Table cells with multiple paragraphs gets wrong formatting (#289)
* Definition lists rendered wrongly in api docs (#1052)
* Citation not styled properly (#1078)
* Long URLs did not wrap (#1193)


Minor Changes
-------------

* Sphinx 5.2 added to test matrix (#1348)
* Python 3.10 added to test matrix (#1334)
* Supplemental Docker setup for development (#1319)
* Most of setup.py migrated to setup.cfg (#1116)
* Jinja2 context variable ``sphinx_version_info`` is now ``(major, minor, -1)``, the patch component is always ``-1``. Reason: It's complicated. (#1345)


Incompatible Changes
--------------------

There are no known incompatible changes in this release. Support for ``docutils`` versions 0.18 and 0.19 are scheduled for our next release.


.. _release-1.0.0:

1.0.0
Expand Down

0 comments on commit a7fc70d

Please sign in to comment.