Commit Graph

200 Commits

Author SHA1 Message Date
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)
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
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
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
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
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
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
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 Bach
3d75e7c8f0 Fix a wrong example, replace non-existing Body Elements with References 2022-08-24 22:55:45 +02:00
Benjamin Bach
ba059c7970 Wrapping up the Docker work, using docker cp again in order to copy assets out of containers 2022-08-24 16:49:29 +02:00
Benjamin Bach
4393bd2039 Merge remote-tracking branch 'upstream/master' into dockerize 2022-08-23 23:40:55 +02:00
Benjamin Bach
445c923e2f Merge remote-tracking branch 'upstream/master' into dockerize 2022-08-23 23:40:23 +02:00
Benjamin Bach
83e122054c Removes Makefile + double FROM in Dockerfile 2022-08-20 00:38:26 +02:00
Benjamin Bach
ba65499354 First updates migrating to docker-compose 2022-08-20 00:20:45 +02:00
Benjamin Bach
7c43f45c9b Do not build the python package in this step 2022-08-19 22:50:49 +02:00
Benjamin Bach
8e737d4c84 Make note about releasing package-lock.json 2022-08-19 22:46:19 +02:00
Benjamin Bach
e844040101 Build everything one step at a time 2022-08-19 22:38:22 +02:00
Benjamin Bach
8e65b61666 Adds wheel and a command to package bdist_wheel + sdist 2022-08-19 22:23:32 +02:00
Benjamin Bach
b50a451097 Remove some text @agjohnson 2022-08-19 21:14:51 +02:00
Benjamin Bach
5087916a03 Do not bump the version in auto-maintained file package-lock.json 2022-08-19 17:46:30 +02:00
Benjamin Bach
0f76e9ba4a Merge branch 'master' of github.com:readthedocs/sphinx_rtd_theme into HEAD 2022-08-19 15:50:16 +02:00
Benjamin Bach
85123c47de Add a demo with Python types (regression test for #1196), rebuild theme.js 2022-08-19 15:47:32 +02:00
Benjamin Bach
19977256de Docker configuration for dev environment 2022-08-19 15:07:01 +02:00
Anthony Johnson
1b4263eadf 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 #1230
2021-09-09 12:42:01 -06:00
Anthony Johnson
9fd4b0269b Add development version back to docs 2021-09-09 12:40:47 -06:00
Anthony Johnson
1f0ba51ec4 Update docs and versions for 1.0.0 release
The RC hasn't raised many issues, so time to move forward with final
release. This will be followed by a PR for 1.1.0-dev1.
2021-09-09 12:35:36 -06:00
Anthony Johnson
b557851511 Make section labels verbose to avoid numeric labels
Perhaps this is a feature of Sphinx I'm not aware of, but using a
version number as the section label resulted in ``#id1`` instead.

I tried autosectionlabel, but as expected there were a lot of errors and
I don't feel it's worthwhile to spend time fixing them right now.
2021-08-23 16:17:49 -06:00
Anthony Johnson
b880004ce0 Replace include of readme on index with actual content
If we want the Readme to have more links, this breaks linking at the
index page in the built documentation. The version is hardcoded in links
in the readme version, and hardcoded links point to the wrong version in
the documentaiton
2021-08-19 13:23:00 -06:00
Anthony Johnson
bdd49c4eb3 Small fixes 2021-08-19 13:23:00 -06:00
Anthony Johnson
022a58f68e Replace outdated information on installation page
Repoint compatibilities to development information page instead.
2021-08-19 13:23:00 -06:00
Anthony Johnson
207ae966ec Add development and usage documentation
This finally defines our supported browsers and dependencies publicly,
and communicates our next several versions that we have planned so far.
This information is starting with 1.0.0, but I did try to capture some
historical information as well.
2021-08-19 13:23:00 -06:00
Anthony Johnson
e1b8d2f54c Bump for next potential release
This is just the release version for development purposes so far.

Requires #1204
2021-08-17 11:03:09 -06:00
Anthony Johnson
c5846e3128 Update translations for 1.0.0rc1
Also note the translation updates in changelog.
2021-08-17 10:01:31 -06:00
Anthony Johnson
3f75a24924 Bump2version release 2021-08-16 11:30:03 -06:00
Anthony Johnson
4c76eac561 Update changelog since last release 2021-08-16 11:28:08 -06:00
Anthony Johnson
e026647701 Update release docs 2021-08-10 16:46:15 -06:00
Anthony Johnson
b74323c2ae Add changelog automation with bump2version 2021-08-10 16:39:41 -06:00