Skip to content

Commit c459137

Browse files
committed
Update the documentation
1 parent a16874f commit c459137

File tree

3 files changed

+25
-22
lines changed

3 files changed

+25
-22
lines changed
File renamed without changes.

CONTRIBUTE.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,29 @@
1818
* [`#####`] - Move the image assets to a dedicated folder
1919
```
2020

21-
### Pull Requests
21+
[//]: # (## Pull Requests)
2222

23-
- https://blog.montrealanalytics.com/4-tips-for-effective-pull-request-naming-f60793998f04]
23+
[//]: # ()
24+
[//]: # (- https://blog.montrealanalytics.com/4-tips-for-effective-pull-request-naming-f60793998f04])
25+
26+
27+
## Building the MkDocs Site
28+
29+
Follow these steps to generate the static documentation using MkDocs.
30+
31+
1. Install the required Python packages:
32+
```bash
33+
pip install -r requirements.txt
34+
```
35+
2. Build the site:
36+
```bash
37+
mkdocs build
38+
```
39+
The generated files will appear in the `site/` directory.
40+
3. To preview the documentation locally, run:
41+
```bash
42+
mkdocs serve
43+
```
44+
45+
Navigation is created automatically by the `mkdocs-awesome-pages-plugin` based on
46+
files inside the `docs/` folder.

build_mkdocs.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)