File tree Expand file tree Collapse file tree 2 files changed +11
-1
lines changed Expand file tree Collapse file tree 2 files changed +11
-1
lines changed Original file line number Diff line number Diff line change
1
+ # Instructions for the cf-python gallery of code recipes
2
+
3
+ ## Environment
4
+
1
5
* The generation of recipes using Sphinx-Gallery requires ` Python<3.12.0 ` and:
2
6
3
7
``` txt
14
18
pip install alabaster==0.7.13
15
19
pip install sphinx==2.4.5
16
20
```
21
+
22
+ ## Notes
17
23
18
24
* The ` .py ` files to generate recipes are stored in ` docs/source/recipes/ ` .
19
25
51
57
<button data-filter =" testfilter" >Test</button >
52
58
</div >
53
59
```
60
+
61
+ ## Building for a release
62
+
63
+ TODO
Original file line number Diff line number Diff line change 60
60
./test_tutorial_code
61
61
```
62
62
63
- - [ ] ** Follow all of the steps outlined externally in ` DOCUMENTATION .md` ** ,
63
+ - [ ] ** Follow all of the steps outlined externally in ` RECIPES .md` ** ,
64
64
notably so that the correct Sphinx-related environment is prepared for
65
65
documentation building.
66
66
You can’t perform that action at this time.
0 commit comments