You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our guidebook is built with [Sphinx](https://sphinx-doc.org) which is a documentation tool and uses the pyos-sphinx-theme which customizes the pydata-sphinx-theme.
48
-
49
-
The easiest way to build our documentation is to use [the `nox` automation tool](https://nox.thea.codes/),
50
-
a tool for quickly building environments and running
51
-
commands within them.
52
-
53
-
Using `nox` ensures that your environment has all the dependencies needed to build the documentation.
54
-
55
-
To build, follow these steps:
56
-
57
-
1. Install `nox`
58
-
59
-
```console
60
-
python -m pip install nox
61
-
```
28
+
### Using Binder for workshops
62
29
63
-
2. Build the documentation:
64
-
65
-
```console
66
-
nox -s docs
67
-
```
68
-
69
-
This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/html`.
30
+
1. Click on the Binder badge at the top of this README.
31
+
2. Wait 15-60 seconds and Binder will open a Jupyter Lab instance for you to use.
32
+
3. We use [Jupytext](https://jupytext.readthedocs.io/en/latest/) to author our notebooks and lessons.
33
+
These lessons are stored as Markdown (`.md`) files.
34
+
4. To open a Markdown (Jupytext file) file, highlight the file in the left sidebar and right click to
35
+
bring up a context sensitive menu. Select "Open with Jupytext".
36
+
5. Enjoy discovering and learning in the notebook. **Remember** Shift-Enter or the play button executes
37
+
a highlighted cell
70
38
71
-
To build live documentation that updates when you update local files, run the following command:
39
+
### Using Codespaces for workshops
72
40
73
-
```console
74
-
nox -s docs-live
75
-
```
41
+
We use [Codespaces](https://github.com/features/codespaces) in some lessons to offer a fully configured, general coding environment for users.
76
42
77
-
## Contributing to pyOpenSci lessons
43
+
## Gratitude
78
44
79
-
We welcome and issues and pull requests to improve the content of this guide.
80
-
If you'd like to see an improvement, please [open an issue](https://github.com/pyOpenSci/lessons/issues/new/choose).
45
+
Thank you to [2i2c](https://2i2c.org/) for providing a Binder instance that we can use for workshops.
46
+
We're grateful for the work that they are doing to support open learning and discovery.
81
47
82
48
## Contributors ✨
83
49
@@ -119,22 +85,53 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
119
85
120
86
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
121
87
122
-
## Star History
88
+
## Contributing
123
89
124
-
[](https://star-history.com/#pyOpenSci/lessons&Date)
90
+
We welcome and issues and pull requests to improve the content of these lessons.
91
+
If you'd like to see an improvement, please [open an issue](https://github.com/pyOpenSci/lessons/issues/new/choose).
125
92
126
-
##Gratitude
93
+
### Getting started
127
94
128
-
Thank you to [2i2c](https://2i2c.org/) for providing a Binder instance that we can use for workshops.
129
-
We're grateful for the work that they are doing to support open learning and discovery.
95
+
This repository contains the source files for the [pyOpenSci Tutorials](https://pyopensci.org/lessons). We use Jupytext, MystMarkdown and Sphinx to maintain these lessons.
130
96
131
-
### Workshop access to Binder
97
+
### Build the guidebook locally
132
98
133
-
1. Click on the Binder badge at the top of this README.
134
-
2. Wait 15-60 seconds and Binder will open a Jupyter Lab instance for you to use.
135
-
3. We use [Jupytext](https://jupytext.readthedocs.io/en/latest/) to author our notebooks and lessons.
136
-
These lessons are stored as Markdown (`.md`) files.
137
-
4. To open a Markdown (Jupytext file) file, highlight the file in the left sidebar and right click to
138
-
bring up a context sensitive menu. Select "Open with Jupytext".
139
-
5. Enjoy discovering and learning in the notebook. **Remember** Shift-Enter or the play button executes
140
-
a highlighted cell
99
+
Our guidebook is built with [Sphinx](https://sphinx-doc.org) which is a documentation tool and uses the pyos-sphinx-theme which customizes the pydata-sphinx-theme.
100
+
101
+
The easiest way to build our documentation is to use [the `nox` automation tool](https://nox.thea.codes/),
102
+
a tool for quickly building environments and running
103
+
commands within them.
104
+
105
+
Using `nox` ensures that your environment has all the dependencies needed to build the documentation.
106
+
107
+
To build, follow these steps:
108
+
109
+
1. Install `nox`
110
+
111
+
```console
112
+
python -m pip install nox
113
+
```
114
+
115
+
2. Build the documentation:
116
+
117
+
```console
118
+
nox -s docs-test
119
+
```
120
+
121
+
This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/html`.
122
+
123
+
To build live documentation that updates when you update local files, run the following command:
124
+
125
+
```console
126
+
nox -s docs-live
127
+
```
128
+
129
+
### Code formatting in Jupyter
130
+
131
+
If you are working on the notebooks, you may want to apply ruff for code formatting. Instructions on how to set this up in Jupyter Lab are below:
0 commit comments