Skip to content

Commit 0937dec

Browse files
committed
Merge installation and first-computation into one Getting started page
The Getting started nav entry landed on a thin hub that only listed two sub-pages. Fold both into getting-started/index.md so the entry opens a real page on the first click: an Installation section (uv, pip, legacy conda) followed by the end-to-end first computation. The page is now an executable notebook, so drop it from the jupytext hook's index.md exclusion (it is read via the myst backend, not pandoc) and exclude getting-started/*.ipynb from Sphinx source collection to avoid a duplicate-document warning for the paired notebook.
1 parent 54f80d4 commit 0937dec

6 files changed

Lines changed: 286 additions & 242 deletions

File tree

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,5 @@ repos:
5555
# is absent on CI runners and would crash the hook; excluding the
5656
# section-hub index.md files keeps the sync to files jupytext can read.
5757
files: ^docs/(getting-started|tutorials)/.*\.md$
58-
exclude: ^docs/(getting-started|tutorials)/index\.md$
58+
exclude: ^docs/tutorials/index\.md$
5959
require_serial: true

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@
3030
"superpowers/**",
3131
"**/.ipynb_checkpoints",
3232
"examples/IIT_4.0_demo.ipynb",
33-
"getting-started/first-computation.ipynb",
34-
# Paired tutorial notebooks are download artifacts; the .md is the rendered
35-
# source. Exclude the .ipynb so Sphinx does not see two files per document.
33+
# Paired notebooks are download artifacts; the .md is the rendered source.
34+
# Exclude the .ipynb so Sphinx does not see two files per document.
35+
"getting-started/*.ipynb",
3636
"tutorials/*.ipynb",
3737
]
3838

docs/getting-started/first-computation.md

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

0 commit comments

Comments
 (0)