File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -158,28 +158,25 @@ Server ping:
158158
159159## Documentation
160160
161- The project documentation is built with [ Material for MkDocs] ( https://squidfunk.github.io/mkdocs-material/ ) and deployed to GitHub Pages.
161+ Link here: https://josephlim94.github.io/python_janus_client/
162+
163+ ## Dev
162164
163165### Documentation Development
164166
165- #### Setup
167+ The project documentation is built with [ Material for MkDocs ] ( https://squidfunk.github.io/mkdocs-material/ ) and deployed to GitHub Pages.
166168
167- Install development dependencies:
169+ #### Setup
168170
169171``` bash
172+ # Install development dependencies
170173hatch env create
171- ```
172174
173- #### Local Development
174-
175- To serve the documentation locally with live reload:
176-
177- ``` bash
175+ # To serve the documentation locally with live reload
176+ # Should be available at http://127.0.0.1:8000/
178177hatch run docs-serve
179178```
180179
181- The documentation will be available at http://127.0.0.1:8000/
182-
183180#### Building Documentation
184181
185182To build the documentation for production:
@@ -199,8 +196,6 @@ hatch run mkdocs build
199196hatch run +py=3.8 mkdocs build # to build in a specific python environment only, not all
200197```
201198
202- ## Dev
203-
204199### Run unit tests
205200
206201Use following command to run unit tests and see all logs:
You can’t perform that action at this time.
0 commit comments