Skip to content

Commit 0253366

Browse files
committed
Small fixes in build instructions, fix warnings
Since the build instructions suggest using pipenv, we should consistently use pipenv to install the packages. Also remove some warnings about unavailable static files. Fix a Sphinx deprecation warning.
1 parent f0b8ea0 commit 0253366

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

document/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pipenv shell
4242
Install Python dependencies:
4343

4444
```
45-
pip install Sphinx==2.4.4
45+
pipenv install Sphinx==2.4.4
4646
```
4747

4848
### Checking out the repository
@@ -80,7 +80,7 @@ To build the [single-page W3C version](https://webassembly.github.io/spec/core/b
8080
```
8181
# cd back to root of git directory
8282
git clone https://github.com/tabatkins/bikeshed.git
83-
pip install --editable bikeshed
83+
pipenv install -e bikeshed
8484
bikeshed update
8585
```
8686

document/core/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
# Add any paths that contain custom static files (such as style sheets) here,
187187
# relative to this directory. They are copied after the builtin static files,
188188
# so a file named "default.css" will overwrite the builtin "default.css".
189-
html_static_path = ['_static', 'static/custom.css']
189+
html_static_path = ['static/custom.css']
190190

191191
# Add any extra paths that contain custom files (such as robots.txt or
192192
# .htaccess) here, relative to this directory. These files are copied

document/core/util/bikeshed/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@
130130
# a list of builtin themes.
131131
#
132132
html_theme = 'classic'
133-
html_add_permalinks = None
133+
html_add_permalinks = ''
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
@@ -176,7 +176,7 @@
176176
# Add any paths that contain custom static files (such as style sheets) here,
177177
# relative to this directory. They are copied after the builtin static files,
178178
# so a file named "default.css" will overwrite the builtin "default.css".
179-
html_static_path = ['_static', 'static/custom.css']
179+
# html_static_path = ['_static', 'static/custom.css']
180180

181181
# Add any extra paths that contain custom files (such as robots.txt or
182182
# .htaccess) here, relative to this directory. These files are copied

document/core/util/mathdef.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from sphinx.ext.mathbase import math
2-
from sphinx.ext.mathbase import MathDirective
2+
from sphinx.directives.patches import MathDirective
33
from sphinx.util.texescape import tex_replace_map
44
from sphinx.writers.html5 import HTML5Translator
55
from sphinx.writers.latex import LaTeXTranslator

document/core/util/mathdefbs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# mathdef.py controlled by buildername.
55

66
from sphinx.ext.mathbase import math
7-
from sphinx.ext.mathbase import MathDirective
7+
from sphinx.directives.patches import MathDirective
88
from sphinx.ext.mathjax import html_visit_math
99
from sphinx.ext.mathjax import html_visit_displaymath
1010
from sphinx.writers.html5 import HTML5Translator

0 commit comments

Comments
 (0)