Skip to content

Commit 54de6a9

Browse files
committed
Add docs dependencies
1 parent fbf7265 commit 54de6a9

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

docs/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
# Building Jupyter-ROS Documentation
1+
# Building JupyterLab-URDF Documentation
22

33
1. Clone the repository and create a new environment for development
44

5-
1. From the root directory, install the extension in editable mode
5+
1. From the root directory, install the dependencies
66

77
```sh
8-
pip install -e .[docs]
8+
jlpm run install:docs
99
```
1010

1111
1. Build the documents
1212

1313
```sh
14-
cd jupyter-ros/docs/
15-
make html
14+
jlpm run build:docs
1615
```
1716

1817
1. Open the documentation locally

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
myst_parser==0.18.0
22
jupyterlite-sphinx
33
sphinx
4+
sphinx-rtd-theme

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
"build:labextension:dev": "jupyter labextension build --development True .",
3535
"build:lib": "tsc --sourceMap",
3636
"build:lib:prod": "tsc",
37+
"build:docs": "cd docs && make html",
3738
"clean": "jlpm clean:lib",
3839
"clean:lib": "rimraf lib tsconfig.tsbuildinfo",
3940
"clean:lintcache": "rimraf .eslintcache .stylelintcache",
@@ -42,6 +43,7 @@
4243
"eslint": "jlpm eslint:check --fix",
4344
"eslint:check": "eslint . --cache --ext .ts,.tsx",
4445
"install:extension": "jlpm build",
46+
"install:docs": "pip install -r docs/requirements.txt",
4547
"lint": "jlpm stylelint && jlpm prettier && jlpm eslint",
4648
"lint:check": "jlpm stylelint:check && jlpm prettier:check && jlpm eslint:check",
4749
"prettier": "jlpm prettier:base --write --list-different",

0 commit comments

Comments
 (0)