@@ -34,7 +34,7 @@ For this workshop, we'll focus on creating user-facing documentation using [MkDo
3434
3535### Setting up MkDocs
3636
37- MkDocs is already set up in the ` softdev-101 ` package.
37+ MkDocs is already set up in the ` dev_tutorial ` package.
3838Let's look at the key components:
3939
4040The ` mkdocs.yml ` configuration file:
@@ -79,7 +79,7 @@ docs = [
7979For the documentation packages, you have to install the `docs` extra :
8080
8181` ` `
82- pip install -e softdev-101 [docs]
82+ pip install -e dev_tutorial [docs]
8383` ` `
8484
8585Notice the `[docs]` at the end : this tells `pip` to also install the optional dependencies specified under `docs`.
@@ -94,7 +94,7 @@ mkdocs build
9494
9595` ` ` console {.no-copy}
9696INFO - Cleaning site directory
97- INFO - Building documentation to directory: /path/to/your/dir/softdev-101 /site
97+ INFO - Building documentation to directory: /path/to/your/dir/dev_tutorial /site
9898INFO - Documentation built in 0.22 seconds
9999` ` `
100100
@@ -181,7 +181,7 @@ This command:
181181Your documentation will be available at :
182182
183183` ` `
184- https://<username>.github.io/<repository> /
184+ https://<username>.github.io/dev_tutorial /
185185` ` `
186186
187187For example, this documentation is hosted at : [https://mbercx.github.io/softdev-101/](https://mbercx.github.io/softdev-101/)
0 commit comments