Skip to content

Commit 22eda60

Browse files
style: pre-commit fixes
1 parent b8ba710 commit 22eda60

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This README describes how the _astropy-learn_ organization is designed, how it f
1717
- _tutorial--*_: each tutorial (or book) is its own repo, emulating the _tutorial--template_ file structure.
1818

1919
### How the repos interact
20-
Within a _tutorial--*_ repo, when the [build.yml file](https://github.com/astropy-learn/tutorial--template/blob/main/.github/workflows/build.yml) is triggered, _action--pre-process_ is called to populate the Jupyter Book config script for that notebook. _action--pre-process_ runs the [associated Python script](https://github.com/astropy-learn/astropy-tutorials/blob/main/scripts/pre-process.py) kept in the _astropy-tutorials_ repo.
20+
Within a _tutorial--*_ repo, when the [build.yml file](https://github.com/astropy-learn/tutorial--template/blob/main/.github/workflows/build.yml) is triggered, _action--pre-process_ is called to populate the Jupyter Book config script for that notebook. _action--pre-process_ runs the [associated Python script](https://github.com/astropy-learn/astropy-tutorials/blob/main/scripts/pre-process.py) kept in the _astropy-tutorials_ repo.
2121

2222
Then, the _build.yml_ workflow calls _action--execute-convert_ (which runs the [associated Python script](https://github.com/astropy-learn/astropy-tutorials/blob/main/scripts/execute-convert.py) kept in the _astropy-tutorials_ repo) to build the _.ipynb_ notebook into _.html_. This step determines if a single tutorial page or a Jupyter Book 'book' (collection of notebooks) should be built, as checked in the Python script. The Jupyter Book HTML build outputs are pushed to the _converted_ branch in the tutorial repo.
2323

0 commit comments

Comments
 (0)