Skip to content

Commit c7e7122

Browse files
committed
Add instructions for building docs
1 parent 053b499 commit c7e7122

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/dev_docs.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Building the Docs
2+
=================
3+
4+
1. Clone the repository and create a new environment for development
5+
2. From the root directory, install the dependencies
6+
7+
.. code-block:: bash
8+
9+
jlpm run install:docs
10+
11+
3. Build the documents
12+
13+
.. code-block:: bash
14+
15+
jlpm run build:docs
16+
17+
4. Open the documentation locally
18+
19+
.. code-block:: bash
20+
21+
jlpm run serve:docs
22+
23+
5. From a web browser, navigate to ``localhost:8000``

0 commit comments

Comments
 (0)