Skip to content

Commit 337f6df

Browse files
hamishwilleehamishwillee
committed
Creation of new Community page and removal of news and contact page. Fixes as result of feedback
1 parent 9f5e322 commit 337f6df

19 files changed

Lines changed: 346 additions & 474 deletions

File tree

‎site/source/_themes/emscripten_sphinx_rtd_theme/footer.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@
2929
('https://groups.google.com/forum/#!forum/emscripten-discuss', 'Mailing list', 'Mailing list'),
3030
('https://github.com/kripken/emscripten/wiki', 'Wiki', 'Wiki'),
3131
('https://plus.google.com/100622854474489221138', 'Google+', 'Google+'),
32-
('docs/getting_started/release_notes', 'Release notes', 'Release notes'),
33-
('docs/site/blogs', 'Blogs', 'Blogs'),
32+
('docs/introducing_emscripten/release_notes', 'Release notes', 'Release notes'),
33+
('docs/introducing_emscripten/community', 'Blogs', 'Blogs'),
34+
('docs/introducing_emscripten/community', 'Help', 'Contact'),
3435
] -%}
3536

3637
<div class="footer-nav-bar" style="">
@@ -41,6 +42,8 @@
4142
<a class="footer-navlink-short" title="{{ shorttext }}" href="{{ pathto(document) }}">{{ shorttext }}</a><a class="footer-navlink-long" title="{{ longtext }}" href="{{ pathto(document) }}">{{ longtext }}</a>
4243
{%- elif document | truncate(4, True, end='') == 'http' %}
4344
<a class="footer-navlink-short" href="{{ document }}">{{ shorttext }}</a><a class="footer-navlink-long" href="{{ document }}">{{ longtext }}</a>
45+
{%- else %}
46+
{{ shorttext }}
4447
{%- endif %}
4548
{% endfor %}
4649

‎site/source/_themes/emscripten_sphinx_rtd_theme/layout.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
{%- set titlesuffix = "" %}
88
{%- endif %}
99

10-
<!DOCTYPE html>
10+
<!DOCTYPE html>
1111
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
1212
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
1313
<head>
@@ -129,7 +129,7 @@
129129
{% set navigation_bar = [
130130
('docs/index', 'Docs', 'Documentation'),
131131
('docs/getting_started/downloads', 'SDK', 'Downloads'),
132-
('docs/introducing_emscripten/contact', 'Help', 'Contact'),
132+
('docs/introducing_emscripten/community', 'Help', 'Community'),
133133
('https://github.com/kripken/emscripten', 'Github', 'Github Project')
134134
] -%}
135135

‎site/source/_themes/emscripten_sphinx_rtd_theme/static/css/theme.css‎

Lines changed: 27 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎site/source/docs/api_reference/advanced-apis.rst‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
==========================================
2-
Advanced/Internal APIs (ready-for-review)
2+
Advanced APIs (ready-for-review)
33
==========================================
44

5-
This section lists APIs which are not considered suitable for general use, but which may be useful to some developers in some circumstances. These include APIs that are difficult or complicated to use, or which are intended primarily for Emscripten developers.
5+
This section lists APIs that are not suitable for general use, but which may be useful to developers in some circumstances. These include APIs that are difficult or complicated to use, or which are intended primarily for Emscripten developers.
66

77
.. contents:: Table of Contents
88
:local:
99
:depth: 1
1010

1111

1212

13-
1413
settings.js
1514
============
1615

1716
`settings.js <https://github.com/kripken/emscripten/blob/master/src/settings.js>`_ contains default values and options used in various places by the compiler.
1817

19-
.. Warning :: Many **settings.js** options are highly brittle - certain combination of options and some options used with some source code, can cause Emscripten to fail badly. This is intended for use by "power users", and possibly even only people developing Emscripten itself.
18+
.. Warning :: Many **settings.js** options are highly brittle - certain combinations of options, and combinations of certain options used with some source code, can cause Emscripten to fail badly. This is intended for use by "advanced users", and possibly even only people developing Emscripten itself.
19+
2020
21-
The options are normally set as command line parameters to *emcc*: ::
21+
The options in **settings.js** are normally set as command line parameters to *emcc*: ::
2222

2323
emcc -s OPT=VALUE
2424

2525

26-
While it is possible to edit **settings.js** manually, this is *highly discouraged*. In general **settings.js** defines low-level options that should not be modified. Note also that the compiler changes some options depending on other settings. For example, ``ASSERTIONS`` is disabled in optimized builds (``-O1+``), but enabled by default in default (non-optimized) builds.
26+
While it is possible to edit **settings.js** manually, this is *highly discouraged*. In general **settings.js** defines low-level options that should not be modified. Note also that the compiler changes some options depending on other settings. For example, ``ASSERTIONS`` is enabled by default, but disabled in optimized builds (``-O1+``).
2727

28-
The small number of options that people do need to change should be modified when the tool is invoked. For example, ``EXPORTED_FUNCTIONS``: ::
28+
The small number of options that developers may have cause to change should be modified when the *emcc* tool is invoked. For example, ``EXPORTED_FUNCTIONS``: ::
2929

3030
./emcc tests/hello_function.cpp -o function.html -s EXPORTED_FUNCTIONS="['_int_sqrt']"
3131

@@ -39,11 +39,7 @@ allocate()
3939
Module.Runtime
4040
================
4141

42-
``Module.Runtime`` gives access to some low-level things in the runtime. Some of these, for example ``Runtime.stackSave()`` and ``Runtime.stackRestore()`` may be useful for advanced users.
43-
44-
42+
``Module.Runtime`` gives access to low-level runtime functionality. Some of these, for example ``Runtime.stackSave()`` and ``Runtime.stackRestore()`` may be useful for advanced users.
4543

46-
emscripten_jcache_printf_()
47-
===========================
44+
.. todo:: **HamishW** It would be useful to expand on what is offered by Module.Runtime
4845

49-
``emscripten_jcache_printf_()`` is an internal API documented in `emscripten.h <https://github.com/kripken/emscripten/blob/master/system/include/emscripten/emscripten.h>`_.

‎site/source/docs/api_reference/emscripten.h.rst‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _emscripten-h:
2+
13
================================
24
Emscripten.h (ready-for-review)
35
================================
@@ -26,12 +28,12 @@ Defines
2628

2729
This allows you to declare JavaScript in your C code "inline", which is then executed when your compiled code is run in the browser. For example, the following C code would display two alerts if it was compiled with Emscripten and run in the browser: ::
2830

29-
EM_ASM( window.alert(‘hai’));
30-
window.alert(‘bai’)); )
31+
EM_ASM( alert(‘hai’));
32+
alert(‘bai’)); )
3133
3234
.. note::
3335
- Double-quotes (") cannot be used in the inline assembly/JavaScript. Single-quotes (‘) can be used, as shown above.
34-
- Newlines are supported
36+
- Newlines (\\n, \\r etc.) are supported in the inline Javascript. Note that any platform-specific issues with line endings in normal JavaScript also apply to inline JavaScript declared using ``EM_ASM``.
3537
- This works with **asm.js** (it outlines the code and does a function call to reach it).
3638
- You can’t access C variables with :c:macro:`EM_ASM`, nor receive a value back. Instead use :c:macro:`EM_ASM_INT` or :c:macro:`EM_ASM_DOUBLE`.
3739

@@ -445,7 +447,7 @@ Functions
445447
:type file: const char*
446448
:param requesttype: 'GET' or 'POST'.
447449
:type requesttype: const char*
448-
:param param: Request parameters. If the ``requesttype`` is a POST request, this is a POST parameter like ``key=value&key2=value2``.
450+
:param param: Request parameters for POST requests (see ``requesttype``). The parameters are specified in the same way as they would be in the URL for an equivalent GET request: e.g. ``key=value&key2=value2``.
449451
:type param: const char*
450452
:param void* arg: User-defined data that is passed to the callbacks, untouched by the API itself. This may be be used by a callback to identify the associated call.
451453
:param em_async_wget2_onload_func onload: Callback on successful load of the file. The callback function parameter values are:
@@ -480,7 +482,7 @@ Functions
480482
:type url: const char*
481483
:param requesttype: 'GET' or 'POST'.
482484
:type requesttype: const char*
483-
:param param: Request parameters. If the ``requesttype`` is a POST request, this is a POST parameter like ``key=value&key2=value2``.
485+
:param param: Request parameters for POST requests (see ``requesttype``). The parameters are specified in the same way as they would be in the URL for an equivalent GET request: e.g. ``key=value&key2=value2``.
484486
:type param: const char*
485487
:param void* arg: User-defined data that is passed to the callbacks, untouched by the API itself. This may be be used by a callback to identify the associated call.
486488
:param const int free: Tells the runtime whether to free the returned buffer after ``onload`` is complete. If ``false`` freeing the buffer is the receiver's responsibility.

0 commit comments

Comments
 (0)