Skip to content

Commit bbf6baf

Browse files
committed
Tweak installation docs
1 parent 631b077 commit bbf6baf

File tree

2 files changed

+21
-7
lines changed

2 files changed

+21
-7
lines changed

docs/source/develop-install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Developer install
66
To install a developer version of pythreejs, you will first need to clone
77
the repository::
88

9-
git clone https://github.com/jovyan/pythreejs
9+
git clone https://github.com/jovyan/pythreejs.git
1010
cd pythreejs
1111

1212
Next, install it with a develop install using pip::

docs/source/installing.rst

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ or via conda::
1414
conda install pythreejs
1515

1616

17-
If you installed via pip, you will also have to install / configure the
18-
front-end extension as well. If you are using classic notebook (as opposed to
19-
Jupyterlab), run::
17+
With jupyter notebook version >= 5.3, this should also install and enable the
18+
relevant front-end extensions. If for some reason this did not happen
19+
(e.g. if the notebook server is in a different environment than the kernel),
20+
you can install / configure the front-end extensions manually. If you are using classic
21+
notebook (as opposed to Jupyterlab), run::
2022

2123
jupyter nbextension install [--sys-prefix / --user / --system] --py pythreejs
2224

@@ -27,9 +29,21 @@ with::
2729

2830
jupyter labextension install jupyter-threejs
2931

30-
If you are installing using conda, these commands should be unnecessary, but If
31-
you need to run them the commands should be the same (just make sure you choose the
32-
`--sys-prefix` flag).
32+
33+
Upgrading to 1.x
34+
================
35+
36+
If you are upgrading to version 1.x from a verion prior to 1.0, there are certain
37+
backwards-incompatible changes that you should note::
38+
39+
- ``Plain[Buffer]Geometry`` was renamed to ``[Buffer]Geometry``. This was done in
40+
order to be more consistent with the names used in threejs. The base classes for
41+
geometry are now called ``Base[Buffer]Geometry``. This also avoids the confusion
42+
with ``Plane[Buffer]Geometry``.
43+
44+
- ``LambertMaterial -> MeshLambertMaterial``, and other similar material class
45+
renames were done. Again, this was to more closely match the names used in
46+
three.js itself.
3347

3448

3549
.. links

0 commit comments

Comments
 (0)