Skip to content

Commit c9ed658

Browse files
authored
Upgrade Sphinx to 3.5.2 (WebAssembly#1298)
* Upgrade Sphinx to 3.5.2 The html_add_permalinks configuration was changed in 3.5 (https://www.sphinx-doc.org/en/3.x/usage/configuration.html#confval-html_add_permalinks), we don't want any permalink for the heading (that's the existing behavior). Fix up bikeshed_fixup.py, we were not correctly replacing the spurious "navigation section" and also the Unicode reference. Most of the changes in the output is: - adding viewport meta tag (in Sphinx#7695, since 3.1.0) - sorting order of css files in html - upgrade mathjax to 2.7.7 * Update bikeshed doc to version 1.1
1 parent cfc2c3e commit c9ed658

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ install:
2121
- opam --version
2222
- ocaml --version
2323
- opam install --yes ocamlbuild.0.14.0
24-
- pip install Sphinx==3.0.0
24+
- pip install Sphinx==3.5.2
2525
- git clone https://github.com/tabatkins/bikeshed.git
2626
- pip install --editable $PWD/bikeshed
2727
- bikeshed update

document/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pipenv shell
4242
Install Python dependencies:
4343

4444
```
45-
pipenv install Sphinx==3.0.0
45+
pipenv install Sphinx==3.5.2
4646
```
4747

4848
### Checking out the repository

document/core/index.bs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ED: https://webassembly.github.io/spec/core/bikeshed/
99
Editor: Andreas Rossberg (Dfinity Stiftung)
1010
Repository: WebAssembly/spec
1111
Markup Shorthands: css no, markdown no, algorithm no, idl no
12-
Abstract: This document describes version 1.0 of the core WebAssembly standard, a safe, portable, low-level code format designed for efficient execution and compact representation.
12+
Abstract: This document describes version 1.1 of the core WebAssembly standard, a safe, portable, low-level code format designed for efficient execution and compact representation.
1313
Prepare For TR: true
1414
</pre>
1515

document/core/util/bikeshed/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
# built documents.
6868
#
6969
# The short X.Y version.
70-
version = u'1.0'
70+
version = u'1.1'
7171
# The full version, including alpha/beta/rc tags.
7272
release = version + ''
7373

@@ -130,7 +130,7 @@
130130
# a list of builtin themes.
131131
#
132132
html_theme = 'classic'
133-
html_add_permalinks = ''
133+
html_permalinks = False
134134

135135
# Theme options are theme-specific and customize the look and feel of a theme
136136
# further. For a list of options available for each theme, see the

document/core/util/bikeshed_fixup.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,14 @@ def Main():
4141
<div class="related" role="navigation" aria-label="related navigation">
4242
<h3>Navigation</h3>
4343
<ul>
44-
<li class="nav-item nav-item-0"><a href="index.html#document-index">WebAssembly 1.0</a> &#187;</li>
44+
<li class="nav-item nav-item-0"><a href="#">WebAssembly 1.1</a> &#187;</li>
45+
<li class="nav-item nav-item-this"><a href="">WebAssembly 1.1</a></li>
4546
</ul>
46-
</div>""", '')
47+
</div> """, '')
4748

4849
# Use bikeshed biblio references for unicode and IEEE754
4950
data = data.replace(
50-
"""<a class="reference external" href="http://www.unicode.org/versions/latest/">Unicode</a>""",
51+
"""<a class="reference external" href="https://www.unicode.org/versions/latest/">Unicode</a>""",
5152
"[[!UNICODE]]"
5253
)
5354

0 commit comments

Comments
 (0)