Skip to content

Commit d36d894

Browse files
docs: reorg for nested sections (#835)
* docs: reorg for nested sections Signed-off-by: Henry Schreiner <henryfs@princeton.edu> * style: pre-commit fixes --------- Signed-off-by: Henry Schreiner <henryfs@princeton.edu> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent d71269e commit d36d894

5 files changed

Lines changed: 17 additions & 13 deletions

File tree

docs/guides/gha_basic.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
short_title: GitHub Actions introduction
2+
short_title: Introduction
33
---
44

5-
# GitHub Actions: Intro
5+
# GitHub Actions: Introduction
66

77
{rr}`GH100` The recommended CI for scientific Python projects is GitHub
88
Actions (GHA), although its predecessor Azure is also in heavy usage, and other

docs/guides/gha_pure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
short_title: GitHub Actions for pure Python wheels
2+
short_title: Pure Python projects
33
---
44

5-
# GitHub Actions: Pure Python wheels
5+
# GitHub Actions: Pure Python projects
66

77
We will cover binary wheels [on the next page][], but if you do not have a
88
compiled extension, this is called a universal (pure Python) package, and the

docs/guides/gha_wheels.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
short_title: GitHub Actions for Binary Wheels
2+
short_title: Compiled projects
33
---
44

5-
# GitHub Actions: Binary wheels
5+
# GitHub Actions: Compiled projects
66

77
Building binary wheels is a bit more involved, but can still be done effectively
88
with GHA. This document will introduce [cibuildwheel][] for use in your project.

docs/guides/packaging_compiled.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Packaging Compiled Projects
1+
# Compiled packaging
22

33
<!-- [[[cog
44
from cog_helpers import code_fence, render_cookie, TOMLMatcher

docs/myst.yml

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,18 @@ project:
2222
- file: guides/pytest.md
2323
- file: guides/coverage.md
2424
- file: guides/docs.md
25-
- file: guides/packaging_simple.md
26-
- file: guides/packaging_compiled.md
27-
- file: guides/packaging_classic.md
25+
- title: Packaging
26+
children:
27+
- file: guides/packaging_simple.md
28+
- file: guides/packaging_compiled.md
29+
- file: guides/packaging_classic.md
2830
- file: guides/style.md
2931
- file: guides/typing.md
30-
- file: guides/gha_basic.md
31-
- file: guides/gha_pure.md
32-
- file: guides/gha_wheels.md
32+
- title: GitHub Actions
33+
children:
34+
- file: guides/gha_basic.md
35+
- file: guides/gha_pure.md
36+
- file: guides/gha_wheels.md
3337
- file: guides/security.md
3438
- file: guides/tasks.md
3539
- file: principles/index.md

0 commit comments

Comments
 (0)