forked from WebAssembly/spec
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge 'document/' directory of 'WebAssembly/reference-types/master' (W…
…ebAssembly#91) To work on the `exception-handling` formal spec, this repository should be up to date with the required `reference-types` spec.
- Loading branch information
Showing
86 changed files
with
17,410 additions
and
3,348 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,270 +1,76 @@ | ||
| # Makefile for Sphinx documentation | ||
| # | ||
| DIRS = core js-api web-api | ||
| FILES = index.html | ||
| BUILDDIR = _build | ||
|
|
||
| # You can set these variables from the command line. | ||
| SPHINXOPTS = | ||
| SPHINXBUILD = sphinx-build | ||
| PAPER = a4 | ||
| BUILDDIR = _build | ||
| STATICDIR = _static | ||
| DOWNLOADDIR = _download | ||
| GHPAGESDIR = ../docs | ||
| NAME = WebAssembly | ||
| # Global targets. | ||
|
|
||
| # Internal variables. | ||
| PAPEROPT_a4 = -D latex_paper_size=a4 | ||
| PAPEROPT_letter = -D latex_paper_size=letter | ||
| ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
| # the i18n builder cannot share the environment and doctrees with the others | ||
| I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
|
|
||
| .PHONY: usage | ||
| usage: | ||
| @echo "Please use \`make <target>' where <target> is one of" | ||
| @echo " html to make standalone HTML files" | ||
| @echo " pdf to make standalone PDF file" | ||
| @echo " all to make both" | ||
| @echo " publish to make all and push to gh-pages" | ||
| @echo " help to see more options" | ||
| .PHONY: all | ||
| all: $(BUILDDIR) root $(DIRS) | ||
|
|
||
| .PHONY: help | ||
| help: | ||
| @echo "Usage: \`make <target>' where <target> is one of" | ||
| @echo " html to make standalone HTML files" | ||
| @echo " pdf to make standalone PDF file" | ||
| @echo " all to make both" | ||
| @echo " publish to make all and push to gh-pages" | ||
| @echo " dirhtml to make HTML files named index.html in directories" | ||
| @echo " singlehtml to make a single large HTML file" | ||
| @echo " pickle to make pickle files" | ||
| @echo " json to make JSON files" | ||
| @echo " htmlhelp to make HTML files and a HTML help project" | ||
| @echo " qthelp to make HTML files and a qthelp project" | ||
| @echo " applehelp to make an Apple Help Book" | ||
| @echo " devhelp to make HTML files and a Devhelp project" | ||
| @echo " epub to make an epub" | ||
| @echo " epub3 to make an epub3" | ||
| @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | ||
| @echo " latexpdf to make LaTeX files and run them through pdflatex" | ||
| @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" | ||
| @echo " text to make text files" | ||
| @echo " man to make manual pages" | ||
| @echo " texinfo to make Texinfo files" | ||
| @echo " info to make Texinfo files and run them through makeinfo" | ||
| @echo " gettext to make PO message catalogs" | ||
| @echo " changes to make an overview of all changed/added/deprecated items" | ||
| @echo " xml to make Docutils-native XML files" | ||
| @echo " pseudoxml to make pseudoxml-XML files for display purposes" | ||
| @echo " linkcheck to check all external links for integrity" | ||
| @echo " doctest to run all doctests embedded in the documentation (if enabled)" | ||
| @echo " coverage to run coverage check of the documentation (if enabled)" | ||
| @echo " dummy to check syntax errors of document sources" | ||
|
|
||
| .PHONY: publish | ||
| publish: all deploy | ||
| $(BUILDDIR): | ||
| mkdir -p $@ | ||
|
|
||
| .PHONY: deploy | ||
| deploy: | ||
| GIT_DEPLOY_DIR=$(BUILDDIR)/html sh deploy.sh | ||
|
|
||
| .PHONY: all | ||
| all: pdf html | ||
|
|
||
| .PHONY: pdf | ||
| pdf: latexpdf | ||
| mkdir -p $(BUILDDIR)/html/$(DOWNLOADDIR) | ||
| ln -f $(BUILDDIR)/latex/$(NAME).pdf $(BUILDDIR)/html/$(DOWNLOADDIR)/$(NAME).pdf | ||
| GIT_DEPLOY_DIR=$(BUILDDIR) bash deploy.sh | ||
|
|
||
| .PHONY: publish | ||
| publish: all deploy | ||
|
|
||
| .PHONY: clean | ||
| clean: | ||
| clean: $(DIRS:%=clean-%) | ||
| rm -rf $(BUILDDIR) | ||
| rm -rf $(STATICDIR) | ||
|
|
||
| .PHONY: html | ||
| html: | ||
| $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
| for file in `ls $(BUILDDIR)/html/*.html`; \ | ||
| do \ | ||
| sed s:BASEDIR:.:g <$$file >$$file.out; \ | ||
| mv -f $$file.out $$file; \ | ||
| done | ||
| for file in `ls $(BUILDDIR)/html/*/*.html`; \ | ||
| do \ | ||
| sed s:BASEDIR:..:g <$$file >$$file.out; \ | ||
| sed 's;<body;<script type="text/javascript">MathJax.Hub.Config({TeX: {MAXBUFFER: 10*1024}})</script><body;' \ | ||
| <$$file.out >$$file; \ | ||
| rm -f $$file.out; \ | ||
| done | ||
| @echo | ||
| @echo "Build finished. The HTML pages are in `pwd`/$(BUILDDIR)/html." | ||
|
|
||
| .PHONY: dirhtml | ||
| dirhtml: | ||
| $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml | ||
| @echo | ||
| @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." | ||
| .PHONY: diff | ||
| diff: $(DIRS:%=diff-%) | ||
|
|
||
| .PHONY: singlehtml | ||
| singlehtml: | ||
| $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml | ||
| @echo | ||
| @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." | ||
|
|
||
| .PHONY: pickle | ||
| pickle: | ||
| $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle | ||
| @echo | ||
| @echo "Build finished; now you can process the pickle files." | ||
| # Directory-specific targets. | ||
|
|
||
| .PHONY: json | ||
| json: | ||
| $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json | ||
| @echo | ||
| @echo "Build finished; now you can process the JSON files." | ||
| .PHONY: root | ||
| root: $(BUILDDIR) | ||
| touch $(BUILDDIR)/.nojekyll | ||
| cp -f $(FILES) $(BUILDDIR)/ | ||
|
|
||
| .PHONY: htmlhelp | ||
| htmlhelp: | ||
| $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp | ||
| @echo | ||
| @echo "Build finished; now you can run HTML Help Workshop with the" \ | ||
| ".hhp project file in $(BUILDDIR)/htmlhelp." | ||
| .PHONY: $(DIRS) | ||
| $(DIRS): %: $(BUILDDIR) $(DIRS:%=build-%) $(DIRS:%=dir-%) | ||
|
|
||
| .PHONY: qthelp | ||
| qthelp: | ||
| $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp | ||
| @echo | ||
| @echo "Build finished; now you can run "qcollectiongenerator" with the" \ | ||
| ".qhcp project file in $(BUILDDIR)/qthelp, like this:" | ||
| @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/WebAssembly.qhcp" | ||
| @echo "To view the help file:" | ||
| @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/WebAssembly.qhc" | ||
| .PHONY: $(DIRS:%=build-%) | ||
| $(DIRS:%=build-%): build-%: | ||
| (cd $(@:build-%=%); make BUILDDIR=$(BUILDDIR) all) | ||
|
|
||
| .PHONY: applehelp | ||
| applehelp: | ||
| $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp | ||
| @echo | ||
| @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." | ||
| @echo "N.B. You won't be able to view it unless you put it in" \ | ||
| "~/Library/Documentation/Help or install it in your application" \ | ||
| "bundle." | ||
| .PHONY: $(DIRS:%=dir-%) | ||
| $(DIRS:%=dir-%): dir-%: | ||
| mkdir -p $(BUILDDIR)/$(@:dir-%=%) | ||
| rm -rf $(BUILDDIR)/$(@:dir-%=%)/* | ||
| cp -R $(@:dir-%=%)/$(BUILDDIR)/html/* $(BUILDDIR)/$(@:dir-%=%)/ | ||
|
|
||
| .PHONY: devhelp | ||
| devhelp: | ||
| $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | ||
| @echo | ||
| @echo "Build finished." | ||
| @echo "To view the help file:" | ||
| @echo "# mkdir -p $$HOME/.local/share/devhelp/WebAssembly" | ||
| @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/WebAssembly" | ||
| @echo "# devhelp" | ||
| .PHONY: $(DIRS:%=deploy-%) | ||
| $(DIRS:%=deploy-%): deploy-%: | ||
| GIT_DEPLOY_DIR=$(BUILDDIR) GIT_DEPLOY_SUBDIR=$(@:deploy-%=%) bash deploy.sh | ||
|
|
||
| .PHONY: epub | ||
| epub: | ||
| $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub | ||
| @echo | ||
| @echo "Build finished. The epub file is in $(BUILDDIR)/epub." | ||
| .PHONY: $(DIRS:%=publish-%) | ||
| $(DIRS:%=publish-%): publish-%: % deploy-% | ||
|
|
||
| .PHONY: epub3 | ||
| epub3: | ||
| $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 | ||
| @echo | ||
| @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." | ||
| .PHONY: $(DIRS:%=clean-%) | ||
| $(DIRS:%=clean-%): clean-%: | ||
| (cd $(@:clean-%=%); make BUILDDIR=$(BUILDDIR) clean) | ||
| rm -rf $(BUILDDIR)/$(@:clean-%=%) | ||
|
|
||
| .PHONY: latex | ||
| latex: | ||
| $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
| @echo | ||
| @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." | ||
| @echo "Run \`make' in that directory to run these through (pdf)latex" \ | ||
| "(use \`make latexpdf' here to do that automatically)." | ||
| .PHONY: $(DIRS:%=diff-%) | ||
| $(DIRS:%=diff-%): diff-%: | ||
| (cd $(@:diff-%=%); make BUILDDIR=$(BUILDDIR) diff) | ||
|
|
||
| .PHONY: latexpdf | ||
| latexpdf: | ||
| $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
| @echo "Running LaTeX files through pdflatex..." | ||
| $(MAKE) -C $(BUILDDIR)/latex all-pdf | ||
| @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | ||
|
|
||
| .PHONY: latexpdfja | ||
| latexpdfja: | ||
| $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
| @echo "Running LaTeX files through platex and dvipdfmx..." | ||
| $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja | ||
| @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | ||
| # Help. | ||
|
|
||
| .PHONY: text | ||
| text: | ||
| $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text | ||
| @echo | ||
| @echo "Build finished. The text files are in $(BUILDDIR)/text." | ||
|
|
||
| .PHONY: man | ||
| man: | ||
| $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man | ||
| @echo | ||
| @echo "Build finished. The manual pages are in $(BUILDDIR)/man." | ||
|
|
||
| .PHONY: texinfo | ||
| texinfo: | ||
| $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | ||
| @echo | ||
| @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." | ||
| @echo "Run \`make' in that directory to run these through makeinfo" \ | ||
| "(use \`make info' here to do that automatically)." | ||
|
|
||
| .PHONY: info | ||
| info: | ||
| $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | ||
| @echo "Running Texinfo files through makeinfo..." | ||
| make -C $(BUILDDIR)/texinfo info | ||
| @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." | ||
|
|
||
| .PHONY: gettext | ||
| gettext: | ||
| $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale | ||
| @echo | ||
| @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." | ||
|
|
||
| .PHONY: changes | ||
| changes: | ||
| $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | ||
| @echo | ||
| @echo "The overview file is in $(BUILDDIR)/changes." | ||
|
|
||
| .PHONY: linkcheck | ||
| linkcheck: | ||
| $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | ||
| @echo | ||
| @echo "Link check complete; look for any errors in the above output " \ | ||
| "or in $(BUILDDIR)/linkcheck/output.txt." | ||
|
|
||
| .PHONY: doctest | ||
| doctest: | ||
| $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | ||
| @echo "Testing of doctests in the sources finished, look at the " \ | ||
| "results in $(BUILDDIR)/doctest/output.txt." | ||
|
|
||
| .PHONY: coverage | ||
| coverage: | ||
| $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage | ||
| @echo "Testing of coverage in the sources finished, look at the " \ | ||
| "results in $(BUILDDIR)/coverage/python.txt." | ||
|
|
||
| .PHONY: xml | ||
| xml: | ||
| $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml | ||
| @echo | ||
| @echo "Build finished. The XML files are in $(BUILDDIR)/xml." | ||
|
|
||
| .PHONY: pseudoxml | ||
| pseudoxml: | ||
| $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml | ||
| @echo | ||
| @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." | ||
| .PHONY: help | ||
| help: | ||
| @echo "Please use \`make <target>' where <target> is one of" | ||
| @echo " all to build all documents" | ||
| @echo " publish to make all and push to gh-pages" | ||
| @echo " <dir> to build a specific subdirectory" | ||
| @echo " publish-<dir> to build and push a specific subdirectory" | ||
|
|
||
| .PHONY: dummy | ||
| dummy: | ||
| $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy | ||
| @echo | ||
| @echo "Build finished. Dummy builder generates no files." | ||
| .PHONY: usage | ||
| usage: help |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,23 @@ | ||
| # WebAssembly Specification | ||
| # WebAssembly Specifications | ||
|
|
||
| This is (meant to become) the official WebAssembly "language" specification. | ||
| This directory contains the source code for the WebAssembly spec documents, as served from the [webassembly.github.io/spec](https://webassembly.github.io/spec) pages. | ||
| It uses [Sphinx](http://www.sphinx-doc.org/) and [Bikeshed](https://github.com/tabatkins/bikeshed). | ||
|
|
||
| It uses [Sphinx](http://www.sphinx-doc.org/). To install that: | ||
| To install Sphinx: | ||
| ``` | ||
| pip install sphinx | ||
| ``` | ||
| To make HTML (result in `_build/html`): | ||
| ``` | ||
| make html | ||
| ``` | ||
| To make PDF (result in `_build/latex`, requires LaTeX): | ||
|
|
||
| To install Bikeshed, see the instructions [here](https://tabatkins.github.io/bikeshed/#installing). | ||
|
|
||
|
|
||
| To build everything locally (result appears in `_build/`): | ||
| ``` | ||
| make pdf | ||
| make all | ||
| ``` | ||
| To make all: | ||
|
|
||
| To build everything and update [webassembly.github.io/spec](https://webassembly.github.io/spec) with it: | ||
| ``` | ||
| make all | ||
| make publish | ||
| ``` | ||
| Please make sure to only use that once a change has approval. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| _build | ||
| _static | ||
| document/*.pyc |
Oops, something went wrong.