1
1
# Development
2
2
3
+ ## Package
4
+
3
5
Setup your system for development:
4
6
5
7
``` bash
@@ -13,3 +15,38 @@ pytest --nbmake examples/*.ipynb
13
15
If Python code is changed, restart the kernel to see the changes.
14
16
15
17
** Warning** : This project is under active development. Its API and behavior may change at any time. We mean it 🙃.
18
+
19
+ ## Documentation
20
+
21
+ Setup your system for documentation development on Unix-like systems:
22
+
23
+ ``` bash
24
+ git clone https://github.com/InsightSoftwareConsortium/itkwidgets.git
25
+ cd itkwidgets/docs
26
+ pip install -r requirements.txt
27
+ ```
28
+
29
+ Build and serve the documentation:
30
+
31
+ ``` bash
32
+ make html
33
+ python -m http.server -d _build/html 8787
34
+ ```
35
+
36
+ Then visit * http://localhost:8787/ * to see the rendered documentation.
37
+
38
+ ### JupyterLite
39
+
40
+ The documentation includes an embedded JupyterLite deployment. To update the
41
+ JupyterLite deployment, it is recommended to call ` make clean ` before starting
42
+ a new build to avoid build caching issues. Also, serve the rendered
43
+ documentation on a different port to avoid browser caching issues.
44
+
45
+ Notebooks served in the JupyterLite deployment can be found at
46
+ * docs/jupyterlite/files* .
47
+
48
+ Support package wheels, including the ` itkwidgets ` wheel are referenced in
49
+ * docs/jupyter/jupyterlite_config.json* . To update the URLs there, copy the
50
+ download link address for a wheel found at https://pypi.org in a package's * Download
51
+ files* page. Additional wheel files, if not on PyPI, can be added directly at
52
+ * docs/jupyterlite/files/* .
0 commit comments