Skip to content

Commit 60419a6

Browse files
committed
🐛 Update dev-tutorial references
1 parent b3880e0 commit 60419a6

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/documentation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -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.
3838
Let's look at the key components:
3939

4040
The `mkdocs.yml` configuration file:
@@ -79,7 +79,7 @@ docs = [
7979
For 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

8585
Notice 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}
9696
INFO - 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
9898
INFO - Documentation built in 0.22 seconds
9999
```
100100

@@ -181,7 +181,7 @@ This command:
181181
Your documentation will be available at:
182182

183183
```
184-
https://<username>.github.io/<repository>/
184+
https://<username>.github.io/dev_tutorial/
185185
```
186186

187187
For example, this documentation is hosted at: [https://mbercx.github.io/softdev-101/](https://mbercx.github.io/softdev-101/)

docs/tests.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ pip install -e .[tests]
4747

4848
This installs your package in editable mode (`-e`) along with the test dependencies.
4949

50-
For the `softdev-101` package, pytest is already included in the `tests` optional dependencies:
50+
For the `dev_tutorial` package, pytest is already included in the `tests` optional dependencies:
5151

5252
```toml
5353
[project.optional-dependencies]
@@ -102,7 +102,7 @@ The key elements:
102102
Fixtures are reusable pieces of code that set up test conditions.
103103
They're defined in `conftest.py` and can be used across multiple test files.
104104

105-
Here's the example from `softdev-101`:
105+
Here's the example from `dev_tutorial`:
106106

107107
```python
108108
# tests/conftest.py

0 commit comments

Comments
 (0)