Skip to content

Commit dbcfe5b

Browse files
authored
Add instructions to build the html site to README. (numpy#83)
1 parent 5a05638 commit dbcfe5b

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ or navigate to any of the documents listed below and download it individually.
1818
4. [Tutorial: Saving and sharing your NumPy arrays](content/save-load-arrays.md)
1919
5. [Tutorial: NumPy deep learning on MNIST from scratch](content/tutorial-deep-learning-on-mnist.md)
2020
6. [Tutorial: X-ray image processing](content/tutorial-x-ray-image-processing.md)
21-
7. [Tutorial: NumPy deep reinforcement learning with Pong from pixels](content/tutorial-deep-reinforcement-learning-with-pong-from-pixels.md)
21+
7. [Tutorial: NumPy deep reinforcement learning with Pong from pixels](content/tutorial-deep-reinforcement-learning-with-pong-from-pixels.md)
2222
8. [Tutorial: Masked Arrays](content/tutorial-ma.md)
2323
9. [Tutorial: Static Equilibrium](content/tutorial-static_equilibrium.md)
2424

@@ -136,6 +136,20 @@ author, if applicable.</b>
136136
For more information about GitHub and its workflow, you can see
137137
[this document](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests).
138138

139+
140+
### Building the Sphinx site locally
141+
142+
Building the tutorials website, which is published at
143+
https://github.com/numpy/numpy-tutorials, locally isn't necessary before making
144+
a contribution, but may be helpful:
145+
146+
```bash
147+
conda env create -f environment.yml
148+
conda activate numpy-tutorials
149+
cd site
150+
make html
151+
```
152+
139153
## Useful links and resources
140154

141155
The following links may be useful:
@@ -149,3 +163,4 @@ The following links may be useful:
149163
Note that regular documentation issues for NumPy can be found in the [main NumPy
150164
repository](https://github.com/numpy/numpy/issues) (see the `Documentation`
151165
labels there).
166+

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy