Skip to content

Commit 7997f61

Browse files
Rename DOCUMENTATION.md file for clarity & split into sections
1 parent 2639538 commit 7997f61

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

DOCUMENTATION.md renamed to RECIPES.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# Instructions for the cf-python gallery of code recipes
2+
3+
## Environment
4+
15
* The generation of recipes using Sphinx-Gallery requires `Python<3.12.0` and:
26

37
```txt
@@ -14,6 +18,8 @@
1418
pip install alabaster==0.7.13
1519
pip install sphinx==2.4.5
1620
```
21+
22+
## Notes
1723

1824
* The `.py` files to generate recipes are stored in `docs/source/recipes/`.
1925

@@ -51,3 +57,7 @@
5157
<button data-filter="testfilter">Test</button>
5258
</div>
5359
```
60+
61+
## Building for a release
62+
63+
TODO

RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
./test_tutorial_code
6161
```
6262

63-
- [ ] **Follow all of the steps outlined externally in `DOCUMENTATION.md`**,
63+
- [ ] **Follow all of the steps outlined externally in `RECIPES.md`**,
6464
notably so that the correct Sphinx-related environment is prepared for
6565
documentation building.
6666

0 commit comments

Comments
 (0)