Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docutils 0.18 issue fixes #1351

Closed
wants to merge 17 commits into from
+46 −5
Closed

Docutils 0.18 issue fixes #1351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
bc05685
Support docutils 0.18
edgarrmondragon Jul 19, 2022
55f7d70
Merge remote-tracking branch 'upstream/master' into HEAD
benjaoming Aug 19, 2022
30e6ffe
Merge remote-tracking branch 'upstream/master' into HEAD
benjaoming Aug 19, 2022
d278e3b
Add new Sphinx versions to tox test matrix, but do not allow docutils…
benjaoming Aug 23, 2022
8bfc509
Stop py2 and py27 support from sphinxlatest because of build breakage
benjaoming Aug 23, 2022
67cbb56
Circle CI: Repeat sphinx versions for Python 2.7 (pending adjustments)
benjaoming Aug 23, 2022
db4981c
tox.ini config: Ensure that we are getting the expected Sphinx version
benjaoming Aug 23, 2022
02c46ba
Merge branch 'master' of github.com:readthedocs/sphinx_rtd_theme into…
benjaoming Aug 24, 2022
49ddc86
Adds the exact approach from Fury, adjustments pending, credits @prad…
benjaoming Oct 5, 2022
bcfbfc8
Merge branch 'master' of github.com:readthedocs/sphinx_rtd_theme into…
benjaoming Oct 5, 2022
48b1cd5
Merge branch 'docutils-0.18' into docutils-0.18-issue-fixes
benjaoming Oct 5, 2022
bddcb77
Adds SASS rules for aside.footnote to match former footnote font colo…
benjaoming Oct 5, 2022
11a1bd5
Update theme.css for https://github.com/readthedocs/sphinx_rtd_theme/…
benjaoming Oct 5, 2022
c8d26b2
Merge branch 'master' of github.com:readthedocs/sphinx_rtd_theme into…
benjaoming Nov 14, 2022
80a4e90
Update theme.css after master branch merge
benjaoming Nov 14, 2022
bed86c5
Update styling fo rdocutils 0.18 DOM to look close to previous docuti…
benjaoming Nov 14, 2022
249b198
New release of sphinxcontrib-httpdomain==1.8.1 broke tests
benjaoming Nov 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
sphinx>=3.0

# NB! sphinxcontrib-httpdomain dropped Sphinx 1.7 support
# https://github.com/sphinx-contrib/httpdomain/issues/64
sphinxcontrib-httpdomain
2 changes: 1 addition & 1 deletion setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ packages = sphinx_rtd_theme
python_requires = >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
install_requires =
sphinx >=1.6,<6
docutils <0.18
docutils <0.19
tests_require =
pytest

Expand Down
2 changes: 1 addition & 1 deletion sphinx_rtd_theme/static/css/theme.css
View file
Open in desktop

Large diffs are not rendered by default.

41 changes: 39 additions & 2 deletions src/sass/_theme_rst.sass
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,8 @@
content: ":"
> dt, > dd
margin-bottom: 0rem


dl.footnote, dl.citation
font-size: .9rem
> dt
Expand All @@ -345,9 +347,44 @@
dl.option-list
kbd
font-size: 0.9rem

// docutils >= 0.18
aside.footnote-list,
div.citation-list
margin-bottom: 2rem;

aside.footnote,
div.citation
display: block
font-size: 0.9rem
padding-left: 1rem
margin-bottom: .5rem
clear: both;
> p, > span
font-size: 0.9rem
line-height: 24px
margin-right: 0.5rem
margin-bottom: .5rem
> span
float: left
display: block
> span.backrefs
font-style: italic
> p
margin-left: 3rem
margin-bottom: 0
overflow: hidden // This is a CSS hack'ish way of making the text wrap
// equally along the left side, rather than "floating"
// ...like this comment! :)

// Both
html.writer-html4 & table.docutils.citation, table.docutils.footnote,
html.writer-html5 & dl.footnote, dl.citation
html.writer-html4 & table.docutils.citation,
html.writer-html4 & table.docutils.footnote,
html.writer-html5 & dl.footnote,
html.writer-html5 & dl.citation,
// For some odd reason, with docutils 0.18, this is a div.citation not aside.citation
html.writer-html5 & div.citation,
html.writer-html5 & aside.footnote
color: $text-medium
code
color: $gray
Expand Down
3 changes: 2 additions & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ deps =
.
readthedocs-sphinx-ext
pytest
sphinxcontrib-httpdomain
sphinx17: Sphinx>=1.7,<1.8
sphinx17: sphinxcontrib-httpdomain<1.8.1
sphinx18: Sphinx>=1.8,<1.9
sphinx20: Sphinx>=2.0,<2.1
sphinx21: Sphinx>=2.1,<2.2
Expand Down Expand Up @@ -44,6 +44,7 @@ deps =
# because it didn't ship with this upper bound.
# See: https://github.com/sphinx-doc/sphinx/issues/10291
sphinx{17,18,20,21,22,23,24,30,31,32,33,34,35,40}: Jinja2<3.1
sphinx{18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,43,44,45,50,51,52,latest}: sphinxcontrib-httpdomain
sphinxlatest: Sphinx
sphinxdev: https://github.com/sphinx-doc/sphinx/archive/refs/heads/master.zip
commands =
Expand Down