File tree Expand file tree Collapse file tree 3 files changed +7
-5
lines changed Expand file tree Collapse file tree 3 files changed +7
-5
lines changed Original file line number Diff line number Diff line change 1
- # Building Jupyter-ROS Documentation
1
+ # Building JupyterLab-URDF Documentation
2
2
3
3
1 . Clone the repository and create a new environment for development
4
4
5
- 1 . From the root directory, install the extension in editable mode
5
+ 1 . From the root directory, install the dependencies
6
6
7
7
``` sh
8
- pip install -e .[ docs]
8
+ jlpm run install: docs
9
9
```
10
10
11
11
1 . Build the documents
12
12
13
13
``` sh
14
- cd jupyter-ros/docs/
15
- make html
14
+ jlpm run build:docs
16
15
```
17
16
18
17
1 . Open the documentation locally
Original file line number Diff line number Diff line change 1
1
myst_parser == 0.18.0
2
2
jupyterlite-sphinx
3
3
sphinx
4
+ sphinx-rtd-theme
Original file line number Diff line number Diff line change 34
34
"build:labextension:dev" : " jupyter labextension build --development True ." ,
35
35
"build:lib" : " tsc --sourceMap" ,
36
36
"build:lib:prod" : " tsc" ,
37
+ "build:docs" : " cd docs && make html" ,
37
38
"clean" : " jlpm clean:lib" ,
38
39
"clean:lib" : " rimraf lib tsconfig.tsbuildinfo" ,
39
40
"clean:lintcache" : " rimraf .eslintcache .stylelintcache" ,
42
43
"eslint" : " jlpm eslint:check --fix" ,
43
44
"eslint:check" : " eslint . --cache --ext .ts,.tsx" ,
44
45
"install:extension" : " jlpm build" ,
46
+ "install:docs" : " pip install -r docs/requirements.txt" ,
45
47
"lint" : " jlpm stylelint && jlpm prettier && jlpm eslint" ,
46
48
"lint:check" : " jlpm stylelint:check && jlpm prettier:check && jlpm eslint:check" ,
47
49
"prettier" : " jlpm prettier:base --write --list-different" ,
You can’t perform that action at this time.
0 commit comments