Skip to content

Commit 2182e62

Browse files
committed
misc docs fixes
1 parent a28384e commit 2182e62

File tree

8 files changed

+10
-8
lines changed

8 files changed

+10
-8
lines changed

docs/Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ ADD docs/__init__.py ./docs/
3737
ADD docs/app.py ./docs/
3838
ADD docs/examples.py ./docs/
3939
ADD docs/source ./docs/source
40+
ADD branding ./branding
4041

4142
RUN pip install -r requirements/build-docs.txt
4243
RUN sphinx-build -W -b html docs/source docs/build

docs/source/_custom_js/rollup.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ export default {
1313
commonjs(),
1414
replace({
1515
"process.env.NODE_ENV": JSON.stringify("production"),
16+
preventAssignment: true,
1617
}),
1718
],
1819
onwarn: function (warning) {

docs/source/adding-interactivity/components-with-state.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ After clicking "Next", if you check the server logs, you'll discover an
2626
``UnboundLocalError`` error. It turns out that in this case, the ``index = index + 1``
2727
statement is similar to `trying to set global variables
2828
<https://stackoverflow.com/questions/9264763/dont-understand-why-unboundlocalerror-occurs-closure>`__.
29-
Tehcnically there's a way to `fix this error
29+
Technically there's a way to `fix this error
3030
<https://docs.python.org/3/reference/simple_stmts.html#nonlocal>`__, but even if we did,
3131
that still wouldn't fix the underlying problems:
3232

@@ -233,7 +233,7 @@ below highlights a line of code where something of interest occurs:
233233
We've just now told IDOM that we want to update the state of our ``Gallery`` and
234234
that it needs to be re-rendered. More specifically, we are incrementing its
235235
``index``, and once ``Gallery`` re-renders the index *will* be ``1``.
236-
Importantly, at this point, **the value of ``index`` is still ``0``**! This will
236+
Importantly, at this point, the value of ``index`` is still ``0``! This will
237237
only change once the component begins to re-render.
238238

239239
.. tab-item:: 7

docs/source/developing-idom/contributor-guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Contributor Guide
99
This project uses the `GitHub Flow`_ (more detail :ref:`below <Making a Pull Request>`)
1010
for collaboration and consists primarily of Python code and Javascript code. A
1111
:ref:`variety of tools <Development Environment>` are used to aid in its development.
12-
Any code contributed to IDOM is validated by a :ref:` series of tests <Running The
12+
Any code contributed to IDOM is validated by a :ref:`series of tests <Running The
1313
Tests>` to ensure its quality and correctness.
1414

1515

docs/source/escape-hatches/distributing-javascript.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ briefly look at what's required. At a high level, we must consider how to...
5252

5353
1. bundle your Javascript into an `ECMAScript Module`)
5454
2. include that Javascript bundle in a Python package
55-
3. use it as a component in your applciation using IDOM
55+
3. use it as a component in your application using IDOM
5656

5757
In the descriptions to follow we'll be assuming that:
5858

docs/source/escape-hatches/javascript-components.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ adheres to the following interface:
8686
- ``context`` can send events back to the server and load "import sources"
8787
(like a custom component module).
8888

89-
- ``type``is a named export of the current module, or a string (e.g. ``"div"``,
89+
- ``type`` is a named export of the current module, or a string (e.g. ``"div"``,
9090
``"button"``, etc.)
9191

9292
- ``props`` is an object containing attributes and callbacks for the given

docs/source/reference-material/gallery.rst renamed to docs/source/reference-material/examples.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Gallery
2-
=======
1+
Examples
2+
========
33

44
Slideshow
55
---------

docs/source/reference-material/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Reference Material
44
.. toctree::
55
:hidden:
66

7-
gallery
7+
examples
88
hooks-api
99
javascript-api
1010
browser-events

0 commit comments

Comments
 (0)