mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge branch '4.0.x' into 4.x
This commit is contained in:
commit
af6e63ab70
2
.github/workflows/main.yml
vendored
2
.github/workflows/main.yml
vendored
@ -21,7 +21,7 @@ jobs:
|
|||||||
docutils: du16
|
docutils: du16
|
||||||
- name: py39
|
- name: py39
|
||||||
python: 3.9
|
python: 3.9
|
||||||
docutils: du16
|
docutils: du17
|
||||||
coverage: "--cov ./ --cov-append --cov-config setup.cfg"
|
coverage: "--cov ./ --cov-append --cov-config setup.cfg"
|
||||||
# - name: py310-dev
|
# - name: py310-dev
|
||||||
# python: 3.10-dev
|
# python: 3.10-dev
|
||||||
|
51
CHANGES
51
CHANGES
@ -23,7 +23,7 @@ Bugs fixed
|
|||||||
Testing
|
Testing
|
||||||
--------
|
--------
|
||||||
|
|
||||||
Release 4.0.0 beta2 (in development)
|
Release 4.0.0 beta3 (in development)
|
||||||
====================================
|
====================================
|
||||||
|
|
||||||
Dependencies
|
Dependencies
|
||||||
@ -32,15 +32,37 @@ Dependencies
|
|||||||
Incompatible changes
|
Incompatible changes
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
* #9023: Change the CSS classes on :rst:role:`cpp:expr` and
|
|
||||||
:rst:role:`cpp:texpr`.
|
|
||||||
|
|
||||||
Deprecated
|
Deprecated
|
||||||
----------
|
----------
|
||||||
|
|
||||||
Features added
|
Features added
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
|
Bugs fixed
|
||||||
|
----------
|
||||||
|
|
||||||
|
Testing
|
||||||
|
--------
|
||||||
|
|
||||||
|
Release 4.0.0 beta2 (released Apr 29, 2021)
|
||||||
|
===========================================
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
------------
|
||||||
|
|
||||||
|
* Support docutils-0.17. Please notice it changes the output of HTML builder.
|
||||||
|
Some themes do not support it, and you need to update your custom CSS to
|
||||||
|
upgrade it.
|
||||||
|
|
||||||
|
Incompatible changes
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
* #9023: Change the CSS classes on :rst:role:`cpp:expr` and
|
||||||
|
:rst:role:`cpp:texpr`.
|
||||||
|
|
||||||
|
Features added
|
||||||
|
--------------
|
||||||
|
|
||||||
* #8818: autodoc: Super class having ``Any`` arguments causes nit-picky warning
|
* #8818: autodoc: Super class having ``Any`` arguments causes nit-picky warning
|
||||||
* #9095: autodoc: TypeError is raised on processing broken metaclass
|
* #9095: autodoc: TypeError is raised on processing broken metaclass
|
||||||
* #9110: autodoc: metadata of GenericAlias is not rendered as a reference in
|
* #9110: autodoc: metadata of GenericAlias is not rendered as a reference in
|
||||||
@ -60,9 +82,6 @@ Bugs fixed
|
|||||||
* C, C++, fix ``KeyError`` when an ``alias`` directive is the first C/C++
|
* C, C++, fix ``KeyError`` when an ``alias`` directive is the first C/C++
|
||||||
directive in a file with another C/C++ directive later.
|
directive in a file with another C/C++ directive later.
|
||||||
|
|
||||||
Testing
|
|
||||||
--------
|
|
||||||
|
|
||||||
Release 4.0.0 beta1 (released Apr 12, 2021)
|
Release 4.0.0 beta1 (released Apr 12, 2021)
|
||||||
===========================================
|
===========================================
|
||||||
|
|
||||||
@ -201,24 +220,6 @@ Bugs fixed
|
|||||||
Release 3.5.5 (in development)
|
Release 3.5.5 (in development)
|
||||||
==============================
|
==============================
|
||||||
|
|
||||||
Dependencies
|
|
||||||
------------
|
|
||||||
|
|
||||||
Incompatible changes
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
Deprecated
|
|
||||||
----------
|
|
||||||
|
|
||||||
Features added
|
|
||||||
--------------
|
|
||||||
|
|
||||||
Bugs fixed
|
|
||||||
----------
|
|
||||||
|
|
||||||
Testing
|
|
||||||
--------
|
|
||||||
|
|
||||||
Release 3.5.4 (released Apr 11, 2021)
|
Release 3.5.4 (released Apr 11, 2021)
|
||||||
=====================================
|
=====================================
|
||||||
|
|
||||||
|
2
setup.py
2
setup.py
@ -23,7 +23,7 @@ install_requires = [
|
|||||||
'sphinxcontrib-qthelp',
|
'sphinxcontrib-qthelp',
|
||||||
'Jinja2>=2.3',
|
'Jinja2>=2.3',
|
||||||
'Pygments>=2.0',
|
'Pygments>=2.0',
|
||||||
'docutils>=0.14,<0.17',
|
'docutils>=0.14,<0.18',
|
||||||
'snowballstemmer>=1.1',
|
'snowballstemmer>=1.1',
|
||||||
'babel>=1.3',
|
'babel>=1.3',
|
||||||
'alabaster>=0.7,<0.8',
|
'alabaster>=0.7,<0.8',
|
||||||
|
@ -1166,7 +1166,11 @@ def setup_js_tag_helper(app: Sphinx, pagename: str, templatename: str,
|
|||||||
else:
|
else:
|
||||||
# str value (old styled)
|
# str value (old styled)
|
||||||
attrs.append('src="%s"' % pathto(js, resource=True))
|
attrs.append('src="%s"' % pathto(js, resource=True))
|
||||||
return '<script %s>%s</script>' % (' '.join(attrs), body)
|
|
||||||
|
if attrs:
|
||||||
|
return '<script %s>%s</script>' % (' '.join(attrs), body)
|
||||||
|
else:
|
||||||
|
return '<script>%s</script>' % body
|
||||||
|
|
||||||
context['js_tag'] = js_tag
|
context['js_tag'] = js_tag
|
||||||
|
|
||||||
|
@ -215,11 +215,23 @@ def test_math_compat(app, status, warning):
|
|||||||
|
|
||||||
@pytest.mark.sphinx('html', testroot='ext-math',
|
@pytest.mark.sphinx('html', testroot='ext-math',
|
||||||
confoverrides={'extensions': ['sphinx.ext.mathjax'],
|
confoverrides={'extensions': ['sphinx.ext.mathjax'],
|
||||||
'mathjax_config': {'extensions': ['tex2jax.js']}})
|
'mathjax3_config': {'extensions': ['tex2jax.js']}})
|
||||||
def test_mathjax_config(app, status, warning):
|
def test_mathjax3_config(app, status, warning):
|
||||||
app.builder.build_all()
|
app.builder.build_all()
|
||||||
|
|
||||||
content = (app.outdir / 'index.html').read_text()
|
content = (app.outdir / 'index.html').read_text()
|
||||||
|
assert MATHJAX_URL in content
|
||||||
|
assert ('<script>window.MathJax = {"extensions": ["tex2jax.js"]}</script>' in content)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.sphinx('html', testroot='ext-math',
|
||||||
|
confoverrides={'extensions': ['sphinx.ext.mathjax'],
|
||||||
|
'mathjax2_config': {'extensions': ['tex2jax.js']}})
|
||||||
|
def test_mathjax2_config(app, status, warning):
|
||||||
|
app.builder.build_all()
|
||||||
|
|
||||||
|
content = (app.outdir / 'index.html').read_text()
|
||||||
|
assert MATHJAX_URL in content
|
||||||
assert ('<script type="text/x-mathjax-config">'
|
assert ('<script type="text/x-mathjax-config">'
|
||||||
'MathJax.Hub.Config({"extensions": ["tex2jax.js"]})'
|
'MathJax.Hub.Config({"extensions": ["tex2jax.js"]})'
|
||||||
'</script>' in content)
|
'</script>' in content)
|
||||||
|
Loading…
Reference in New Issue
Block a user