Skip to content

Commit 9106e1d

Browse files
authored
docs: 📝 split out guide into multiple pages (#275)
# Description This matches how t-squared does it. Needs no review.
1 parent 6562be2 commit 9106e1d

7 files changed

Lines changed: 353 additions & 192 deletions

File tree

_quarto.yml

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@ website:
1212
repo-url: "https://github.com/seedcase-project/template-python-package"
1313
page-navigation: true
1414
navbar:
15-
logo: _extensions/seedcase-project/seedcase-theme/logos/seedcase/icon.svg
15+
logo: "_extensions/seedcase-project/seedcase-theme/logos/seedcase/icon.svg"
1616
logo-alt: "Seedcase Project logo: Main page"
1717
pinned: true
1818
left:
1919
- text: "Overview"
2020
href: index.qmd
2121
- text: "Guide"
22-
href: docs/guide.qmd
22+
href: docs/guide/index.qmd
2323
tools:
2424
- icon: github
2525
href: "https://github.com/seedcase-project/template-python-package"
26-
aria-label: "GitHub icon: Source code"
26+
aria-label: "GitHub icon: Source repository"
2727
- icon: house
28-
href: https://seedcase-project.org
29-
aria-label: "House icon: Seedcase Project home page"
28+
href: "https://seedcase-project.org"
29+
aria-label: "House icon: Main website for the Seedcase Project"
3030
sidebar:
3131
- id: overview
3232
pinned: true
@@ -36,10 +36,17 @@ website:
3636
href: index.qmd
3737
- CHANGELOG.md
3838
- CONTRIBUTING.md
39+
- id: guide
40+
contents:
41+
- section: "Guide"
42+
href: docs/guide/index.qmd
43+
contents:
44+
- docs/guide/installing.qmd
45+
- docs/guide/using.qmd
46+
- docs/guide/updating.qmd
47+
- docs/guide/next-steps.qmd
3948

4049
format:
4150
seedcase-theme-html:
42-
theme:
43-
- brand
4451
include-before-body:
4552
- "docs/includes/site-counter.html"

docs/guide.qmd

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

docs/guide/index.qmd

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Guide"
3+
listing:
4+
contents: .
5+
type: grid
6+
grid-columns: 1
7+
sort: "order"
8+
fields:
9+
- title
10+
- description
11+
---
12+
13+
This guide gives an overview of how to use this template for creating a
14+
new Python package. It includes instructions for using the template and
15+
post-creation tasks.

docs/guide/installing.qmd

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: "Installing"
3+
description: |
4+
Instructions for installing the required (and optional) programs to use this
5+
template and create a new project from it.
6+
order: 1
7+
---
8+
9+
There are a few programs that are required to use this template to
10+
create a project:
11+
12+
- [uv](https://docs.astral.sh/uv/): A tool for managing Python
13+
environments and running commands.
14+
- [Python](https://www.python.org/): Required by Copier, the template
15+
tool.
16+
- [Copier](https://copier.readthedocs.io/en/stable/): A template tool
17+
for making new projects in a standardised and structured way.
18+
- [just](https://just.systems/man/en/): A build and development
19+
management tool that helps with running common build and check tasks.
20+
21+
You can use uv to install these required programs, so
22+
[install](https://docs.astral.sh/uv/getting-started/installation/) that
23+
first. After you've installed uv, install the other programs using:
24+
25+
```{.bash filename="Terminal"}
26+
uv tool install copier rust-just
27+
```
28+
29+
uv will also install Python for you when you install these tools.
30+
31+
There are some optional, though **strongly recommended**, programs to
32+
install and use in any project created with this template:
33+
34+
- [Git](https://git-scm.com/): For version control and setting up Git to
35+
track the newly created project.
36+
- [Lychee](https://lychee.cli.rs/guides/getting-started/): A link
37+
checker that we include in the `justfile` for checking for broken
38+
links in the files.
39+
- [Quarto](https://quarto.org/): A scientific and technical publishing
40+
system built on Pandoc. The website built with this template is
41+
created with Quarto, and the project created from this template is
42+
also set up to use Quarto too.
43+
- [gh cli](https://cli.github.com/): For managing GitHub repositories
44+
and settings from the command line. There are some post-creation steps
45+
we've included that use gh to simplify setting up a GitHub repository
46+
for the project.

0 commit comments

Comments
 (0)