Skip to content

Commit 5bd780a

Browse files
committed
YAML front matter in tutorial plus make collapsibles render properly
1 parent c46179e commit 5bd780a

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

docs/pages/tutorial.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Tutorial: creating a package using our template
1+
---
2+
title: Template tutorial
3+
layout: default
4+
nav_order: 2
5+
---
6+
7+
## Tutorial: creating a package using our template
28

39
In this tutorial, we will go through the steps to set up a Python package using the `UCL-ARC/python-tooling` 🍪 cookiecutter template.
410
We'll also show you how to use your new package with some of the tools included.
@@ -10,7 +16,7 @@ We'll also show you how to use your new package with some of the tools included.
1016
1117
## ⚙️ Prerequisites for using the template
1218

13-
<details><summary>Click to expand… </summary> <!-- markdownlint-disable-line MD033 -->
19+
<details markdown="1"><summary markdown="span">Click to expand… </summary> <!-- markdownlint-disable-line MD033 -->
1420

1521
To use the template you'll need the following software:
1622

@@ -298,7 +304,7 @@ uv sync --all-groups
298304

299305
from the root of the project repository. Note that `uv>=0.6.7` is required to use the `--group` option.
300306

301-
<details><summary>Using venv as an alternative to uv </summary> <!-- markdownlint-disable-line MD033 -->
307+
<details markdown="1"><summary markdown="span">Using venv as an alternative to uv </summary> <!-- markdownlint-disable-line MD033 -->
302308

303309
Alternatively, you can use the [`venv` module](https://docs.python.org/3/library/venv.html), which is slower and has fewer features, when compared to `uv`, but is built-in to the Python standard library. `venv` has the advantage of being available in any Python (3.3+) environment, but unlike `uv` will not by itself allow you to use a different Python version from the system level install. A common pattern is to store the virtual environment files in a directory `.venv` within the root directory of the project repository. This can be achieved by running
304310

0 commit comments

Comments
 (0)