Commit Graph

1451 Commits

Author SHA1 Message Date
Benjamin Balder Bach
2107797b00 Contributing updates (#1478)
* Add reminder to pull from remote

* Sign git tags
2023-05-23 13:34:46 +02:00
Benjamin Balder Bach
72691f5025 Release 1.2.1 (#1474)
* Run bump2version

* Add changelog
1.2.1
2023-05-23 11:16:18 +02:00
Tapple Gao
d836ff798c Docs: Typo in recommended pinning (#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
2023-05-18 15:08:10 +02:00
Benjamin Balder Bach
4d6de11137 Add a call to add_js_files (sphinxcontrib.query) (#1448)
* 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
2023-05-17 19:46:48 +02:00
Miller Abel
03a86b803c fixed type-o in note on automatic index generation (#1458) 2023-04-22 20:58:10 +02:00
Anthony
ee64d37ac9 Bump to next alpha for development (#1433) 2023-02-07 15:30:54 -08:00
Anthony
9d88b9e4e1 Release 1.2.0 (#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
1.2.0
2023-02-07 13:47:28 -08:00
Benjamin Balder Bach
064b6c9f05 release 1.2.0rc4 (#1430)
* Bump to 1.2.0rc4

* Update changelog

* Update translations

* Chinese (Taiwan) was also a new addition
1.2.0rc4
2023-02-06 18:03:20 +01:00
Benjamin Balder Bach
cd99c0f284 Do not use sphinxcontrib-jquery 3.0.0 but anticipate a fixed release (#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)
2023-02-01 19:18:05 +01:00
Benjamin Balder Bach
6444ca8930 Release 1.2.0rc3 (#1414)
* Bump version to 1.2.0rc3

* Update changelog with more entries and known issues

* Update package-lock
1.2.0rc3
2023-01-18 20:14:31 +01:00
Benjamin Balder Bach
5e80b2bd08 Sphinx 6: Use logo_url instead of logo (#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>
2023-01-17 22:48:39 +01:00
Benjamin Balder Bach
ce20cfccca Updates to package-lock.json for 1.2.0rc2 (#1400)
Updates to package-lock.json
1.2.0rc2
2023-01-04 22:45:54 +01:00
Benjamin Balder Bach
ee488a15d2 1.2.0rc2 (#1397)
* Bump to 1.2.0rc2, add changelog entry on Sphinx 6

* Pull translations (no changes)

* loosen sphinx 6 pinning
2023-01-04 21:47:45 +01:00
Benjamin Balder Bach
f84c4eb558 sphinx-rtd-theme will automatically enable sphinxcontrib-jquery (#1399) 2023-01-04 17:28:19 +01:00
Michael R. Crusoe
0763576a36 support Python 3.11 with Sphinx 5.3+ (#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>
2023-01-04 16:21:01 +01:00
Benjamin Balder Bach
f11e6c0d33 Allow Sphinx version 6 and add dependency for sphinxcontrib-jquery (#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
2022-12-30 19:56:29 +01:00
Benjamin Balder Bach
a87790a4e2 Release 1.2.0rc1 (#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)
1.2.0rc1
2022-12-16 12:25:15 +01:00
Benjamin Balder Bach
27d287d203 Add changelog entry for docutils 0.18 support (#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>
2022-12-15 19:45:12 +01:00
Anthony
a039e52ec5 Add docutils 0.18 citation/footnote support using CSS grid (#1381)
* 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
2022-12-15 13:02:39 +01:00
Daniel Mundra
510c620621 Added hidden text for home link in the breadcrumbs. (#1384)
* Added hidden text for home link in breadcrumbs.

* Update breadcrumbs.html

* Update breadcrumbs.html
2022-11-22 14:48:50 +01:00
Daniel Mundra
478ef67053 Added aria-label to search box input field. (#1380)
Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
2022-11-21 19:16:48 +01:00
Benjamin Balder Bach
8142cd1a16 Eager upgrade of all dependencies in docker development environment (#1350)
* Do an eager upgrade of all dependencies in docker development environment

* Adds a comment about installation of deps and upgrade strategy
2022-11-21 18:20:53 +01:00
Benjamin Balder Bach
3265b4cd61 New release of sphinxcontrib-httpdomain==1.8.1 broke tests (#1383)
* New release of sphinxcontrib-httpdomain==1.8.1 broke tests

* Remove sphinxcontrib-httpdomain
2022-11-17 09:45:13 -08:00
Benjamin Balder Bach
25d6fe3605 Docs: Add upgrade instructions and simplify conf.py (#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>
2022-11-09 13:40:16 +01:00
Anthony
bef1649055 Update versioning docs to be explicit about our versioning workflow (#1373) 2022-11-05 00:24:27 +01:00
Anthony
2e4df57951 Bump development version after 1.1.1 release (#1372) 2022-11-05 00:20:04 +01:00
Anthony
f854c890e1 Bugfix release 1.1.1 (#1371)
* Bugfix release 1.1.1

* Release package updates

* Package lock
* Translations
1.1.1
2022-11-04 12:15:15 -07:00
Maxim Martynov
a6ed75f0d5 Do not overflow object cross references (#1369)
* Do not overflow object cross references

* Rebuild theme for https://github.com/readthedocs/sphinx_rtd_theme/pull/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>
2022-11-04 11:59:17 -07:00
Benjamin Balder Bach
d90440a16d Bump to version 1.1.0 (#1367) 2022-11-01 21:08:22 +01:00
Benjamin Balder Bach
53ec9f8554 Release 1.1.0b3 (#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 615eb528cc.

* Add changelog entry for #1073

* Changelog entry for #1193
2022-10-14 21:03:53 +02:00
Benjamin Balder Bach
7771d05856 Remove Jinja2 dependency (#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
2022-10-13 19:13:41 +02:00
Benjamin Balder Bach
2c31b73c3b Release 1.1.0b1 + 1.1.0b2 (bump versions with bump2version) (#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
2022-10-12 23:59:43 +02:00
Benjamin Balder Bach
c6fa4e7a40 Move context logic for layout.html to jinja (#1356)
* Revert "Update layout.html to support a sphinx version that is not three-integers (#1345)"

This reverts commit 45cf21874f.

* 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
2022-10-12 20:54:10 +02:00
Benjamin Balder Bach
20607e8525 Additions to Tox and Circle CI matrix (#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
2022-10-11 14:01:07 +02:00
Benjamin Balder Bach
b33f27cf95 Adds changelog for 1.1.0alpha1 (#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>
2022-10-07 21:53:50 +02:00
Benjamin Balder Bach
b98a7de83d Translation updates: Pull translations from transifex, push new sources (#1354) 2022-10-07 21:53:22 +02:00
Phil Elson
45cf21874f Update layout.html to support a sphinx version that is not three-integers (#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>
2022-10-03 23:12:51 +02:00
Benjamin Balder Bach
855e89ba52 Add sphinx 5.2 to test matrix (#1348) 2022-10-03 16:36:50 +02:00
Benjamin Balder Bach
70927bf7cf Fixup a wrong merge conflict resolution from #1321 (#1335)
* Fixup a wrong merge conflict resolution from #1321

* Add python_requires again to setup.cfg
2022-08-27 23:15:28 +02:00
Aaron Carlisle
695a4e164c Update Breadcrumb Styles (#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 https://github.com/readthedocs/sphinx_rtd_theme/pull/1073

* Build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1073

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
Co-authored-by: Ana Costa <anacosta.xl@gmail.com>
2022-08-27 22:47:23 +02:00
Ana Costa
ba0dc62448 CSS: Add overflow-wrap to links inside paragraphs (#1193)
* Add overflow-wrap to links inside paragraphs

* Add regression test for very long URLs

* Build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1193

* build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1193

* Build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1193

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
2022-08-27 22:27:59 +02:00
Aaron Carlisle
918ca5bed8 Remove font-smoothing (#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 https://github.com/readthedocs/sphinx_rtd_theme/pull/1094

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
2022-08-27 22:14:46 +02:00
Aaron Carlisle
15fdfa15dc Fix definition lists inside api docs (#1084)
* Fix definition lists inside api docs

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

Fixes #1052

* Build Assets

* Build Assets 2

* New build of theme.css and theme.js

* Regenerate theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1084

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
2022-08-27 22:04:31 +02:00
Benjamin Balder Bach
aeae4c1cf6 Add Python 3.10 support (#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
2022-08-27 09:18:02 +02:00
Benjamin Balder Bach
3e73d1ea1c Build matrix fixes (#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
2022-08-27 08:17:19 +02:00
Ana Costa
b2f52f4328 Fixes #289: Inconsistent table typography sizing (#1215)
* Fix table typography inconsistent sizing

* Remove rule duplication

* Remove <ol> and fix build

* Build new theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1215

* Add an example rendering with paragraphs inside tables

* build theme.css for https://github.com/readthedocs/sphinx_rtd_theme/pull/1215

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
2022-08-27 00:55:59 +02:00
Aaron Carlisle
90463f0abe Fix #1078: Citation not styled properly (#1080)
* Fix #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 #1078: Citation not styled properly #1080"

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
2022-08-26 21:37:36 +02:00
Benjamin Balder Bach
e741681526 Merge pull request #1332 from benjaoming/upper-bound-sphinx6
Add an upper bound for when Sphinx 6 is released
2022-08-24 23:55:51 +02:00
Benjamin Bach
8bdf730bf2 Add an upper bound for when Sphinx 6 is released 2022-08-24 23:10:59 +02:00
Benjamin Balder Bach
10e6562154 Merge pull request #1333 from benjaoming/fix-demo-targets-example
Demo: Replace non-existing `Body Elements` with `References`
2022-08-24 23:09:13 +02:00