Skip to content

Commit 4745100

Browse files
melissawmmelissawm
authored
Merge pull request numpy#88 from rossbar/hierarchical-reorg
Reorganize site to group related content together.
2 parents 173e93f + 970b0c0 commit 4745100

File tree

4 files changed

+160
-139
lines changed

4 files changed

+160
-139
lines changed

‎site/applications.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# NumPy Applications
2+
3+
A collection of highlighting the use of NumPy for applications in science,
4+
engineering, and data analysis.
5+
6+
```{toctree}
7+
---
8+
maxdepth: 1
9+
---
10+
11+
content/mooreslaw-tutorial
12+
content/tutorial-deep-learning-on-mnist
13+
content/tutorial-deep-reinforcement-learning-with-pong-from-pixels
14+
content/tutorial-x-ray-image-processing
15+
content/tutorial-static_equilibrium
16+
```

‎site/contributing.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributing
2+
3+
We very much welcome contributions! If you have an idea or proposal for a new
4+
tutorial, please [open an issue](https://github.com/numpy/numpy-tutorials/issues)
5+
with an outline.
6+
7+
Don’t worry if English is not your first language, or if you can only come up
8+
with a rough draft. Open source is a community effort. Do your best – we’ll help
9+
fix issues.
10+
11+
Images and real-life data make text more engaging and powerful, but be sure what
12+
you use is appropriately licensed and available. Here again, even a rough idea
13+
for artwork can be polished by others.
14+
15+
The NumPy tutorials are a curated collection of
16+
[MyST-NB](https://myst-nb.readthedocs.io/) notebooks. These notebooks are used
17+
to produce static websites and can be opened as notebooks in Jupyter using
18+
[Jupytext](https://jupytext.readthedocs.io).
19+
20+
> __Note:__ You should use [CommonMark](https://commonmark.org) markdown
21+
> cells. Jupyter only renders CommonMark.
22+
23+
## Why Jupyter Notebooks?
24+
25+
The choice of Jupyter Notebook in this repo instead of the usual format
26+
([reStructuredText][rst])
27+
used in the main NumPy documentation has two reasons:
28+
29+
30+
* Jupyter notebooks are a common format for communicating scientific
31+
information.
32+
* Jupyter notebooks can be launched in [Binder](https://www.mybinder.org), so that users can interact
33+
with tutorials
34+
* rST may present a barrier for some people who might otherwise be very
35+
interested in contributing tutorial material.
36+
37+
[rst]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
38+
39+
### Note
40+
41+
You may notice our content is in markdown format (`.md` files). We review and
42+
host notebooks in the [MyST-NB](https://myst-nb.readthedocs.io/) format. We
43+
accept both Jupyter notebooks (`.ipynb`) and MyST-NB notebooks (`.md`).
44+
If you want to sync your `.ipynb` to your `.md` file follow the [pairing
45+
tutorial](content/pairing.md).
46+
47+
```{toctree}
48+
:hidden:
49+
50+
content/pairing
51+
```
52+
53+
## Adding your own tutorials
54+
55+
If you have your own tutorial in the form of a Jupyter notebook (an `.ipynb`
56+
file) and you'd like to try add it out to the repository, follow the steps below.
57+
58+
### Create an issue
59+
60+
Go to <https://github.com/numpy/numpy-tutorials/issues> and create a new issue
61+
with your proposal.
62+
Give as much detail as you can about what kind of content you would like to
63+
write (tutorial, how-to) and what you plan to cover.
64+
We will try to respond as quickly as possible with comments, if applicable.
65+
66+
### Check out our suggested template
67+
68+
You can use this template to make your content consistent with our existing
69+
tutorials:
70+
71+
```{toctree}
72+
---
73+
maxdepth: 1
74+
---
75+
content/tutorial-style-guide
76+
```
77+
78+
### Upload your content
79+
80+
Remember to clear all outputs on your notebook before uploading it.
81+
82+
<ul>
83+
<details>
84+
<summary>
85+
<b>Fork this repository</b> (if you haven't before).
86+
</summary>
87+
<img src="_static/01-fork.gif" width=80% height=80%>
88+
</details>
89+
90+
<details>
91+
<summary>
92+
<b>In your own fork, create a new branch for your content.</b>
93+
</summary>
94+
<img src="_static/02-create_new_branch.gif" width=80% height=80%>
95+
</details>
96+
97+
<details>
98+
<summary>
99+
<b>Add your notebook to the <code>content/</code> directory.</b>
100+
</summary>
101+
<img src="_static/03-upload.gif" width=80% height=80%>
102+
</details>
103+
104+
<b>Update the <code>environment.yml</code> file with the dependencies for your tutorial</b>
105+
(only if you add new dependencies).
106+
107+
<details>
108+
<summary>
109+
<b>Update this <code>README.md</code> to include your new entry.</b>
110+
</summary>
111+
<img src="_static/04-add_to_readme.gif" width=80% height=80%>
112+
</details>
113+
114+
<details>
115+
<summary>
116+
<b>Create a <a href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">pull request.</a> Make sure the "Allow edits and access to secrets by maintainers" option is selected so we can properly review your submission.</b>
117+
</summary>
118+
<img src="_static/05-create_PR.gif" width=80% height=80%>
119+
</details>
120+
121+
🎉 <b>Wait for review!</b>
122+
</ul>
123+
124+
For more information about GitHub and its workflow, you can see
125+
[this document][collab].
126+
127+
[collab]: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests

‎site/features.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# NumPy Features
2+
3+
A collection of notebooks pertaining to built-in NumPy functionality.
4+
5+
```{toctree}
6+
---
7+
maxdepth: 1
8+
---
9+
10+
content/tutorial-svd
11+
content/save-load-arrays
12+
content/tutorial-ma
13+
```

‎site/index.md

Lines changed: 4 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -23,149 +23,14 @@ or use the download icon in the upper-right corner of each tutorial.
2323

2424
```{toctree}
2525
---
26-
maxdepth: 1
26+
maxdepth: 2
2727
---
2828
29-
content/tutorial-style-guide
30-
content/tutorial-svd
31-
content/mooreslaw-tutorial
32-
content/save-load-arrays
33-
content/tutorial-deep-learning-on-mnist
34-
content/tutorial-deep-reinforcement-learning-with-pong-from-pixels
35-
content/tutorial-x-ray-image-processing
36-
content/tutorial-ma
37-
content/tutorial-static_equilibrium
29+
features
30+
applications
31+
contributing
3832
```
3933

40-
## Contributing
41-
42-
We very much welcome contributions! If you have an idea or proposal for a new
43-
tutorial, please [open an issue](https://github.com/numpy/numpy-tutorials/issues)
44-
with an outline.
45-
46-
Don’t worry if English is not your first language, or if you can only come up
47-
with a rough draft. Open source is a community effort. Do your best – we’ll help
48-
fix issues.
49-
50-
Images and real-life data make text more engaging and powerful, but be sure what
51-
you use is appropriately licensed and available. Here again, even a rough idea
52-
for artwork can be polished by others.
53-
54-
The NumPy tutorials are a curated collection of
55-
[MyST-NB](https://myst-nb.readthedocs.io/) notebooks. These notebooks are used
56-
to produce static websites and can be opened as notebooks in Jupyter using
57-
[Jupytext](https://jupytext.readthedocs.io).
58-
59-
> __Note:__ You should use [CommonMark](https://commonmark.org) markdown
60-
> cells. Jupyter only renders CommonMark.
61-
62-
### Why Jupyter Notebooks?
63-
64-
The choice of Jupyter Notebook in this repo instead of the usual format
65-
([reStructuredText][rst])
66-
used in the main NumPy documentation has two reasons:
67-
68-
69-
* Jupyter notebooks are a common format for communicating scientific
70-
information.
71-
* Jupyter notebooks can be launched in [Binder](https://www.mybinder.org), so that users can interact
72-
with tutorials
73-
* rST may present a barrier for some people who might otherwise be very
74-
interested in contributing tutorial material.
75-
76-
[rst]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
77-
78-
#### Note
79-
80-
You may notice our content is in markdown format (`.md` files). We review and
81-
host notebooks in the [MyST-NB](https://myst-nb.readthedocs.io/) format. We
82-
accept both Jupyter notebooks (`.ipynb`) and MyST-NB notebooks (`.md`).
83-
If you want to sync your `.ipynb` to your `.md` file follow the [pairing
84-
tutorial](content/pairing.md).
85-
86-
```{toctree}
87-
:hidden:
88-
89-
content/pairing
90-
```
91-
92-
### Adding your own tutorials
93-
94-
If you have your own tutorial in the form of a Jupyter notebook (an `.ipynb`
95-
file) and you'd like to try add it out to the repository, follow the steps below.
96-
97-
#### Create an issue
98-
99-
Go to <https://github.com/numpy/numpy-tutorials/issues> and create a new issue
100-
with your proposal.
101-
Give as much detail as you can about what kind of content you would like to
102-
write (tutorial, how-to) and what you plan to cover.
103-
We will try to respond as quickly as possible with comments, if applicable.
104-
105-
#### Check out our suggested template
106-
107-
You can use this template to make your content consistent with our existing
108-
tutorials:
109-
110-
```{toctree}
111-
---
112-
maxdepth: 1
113-
---
114-
content/tutorial-style-guide
115-
```
116-
117-
#### Upload your content
118-
119-
Remember to clear all outputs on your notebook before uploading it.
120-
121-
<ul>
122-
<details>
123-
<summary>
124-
<b>Fork this repository</b> (if you haven't before).
125-
</summary>
126-
<img src="_static/01-fork.gif" width=80% height=80%>
127-
</details>
128-
129-
<details>
130-
<summary>
131-
<b>In your own fork, create a new branch for your content.</b>
132-
</summary>
133-
<img src="_static/02-create_new_branch.gif" width=80% height=80%>
134-
</details>
135-
136-
<details>
137-
<summary>
138-
<b>Add your notebook to the <code>content/</code> directory.</b>
139-
</summary>
140-
<img src="_static/03-upload.gif" width=80% height=80%>
141-
</details>
142-
143-
<b>Update the <code>environment.yml</code> file with the dependencies for your tutorial</b>
144-
(only if you add new dependencies).
145-
146-
<details>
147-
<summary>
148-
<b>Update this <code>README.md</code> to include your new entry.</b>
149-
</summary>
150-
<img src="_static/04-add_to_readme.gif" width=80% height=80%>
151-
</details>
152-
153-
<details>
154-
<summary>
155-
<b>Create a <a href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">pull request.</a> Make sure the "Allow edits and access to secrets by maintainers" option is selected so we can properly review your submission.</b>
156-
</summary>
157-
<img src="_static/05-create_PR.gif" width=80% height=80%>
158-
</details>
159-
160-
🎉 <b>Wait for review!</b>
161-
</ul>
162-
163-
For more information about GitHub and its workflow, you can see
164-
[this document][collab].
165-
166-
[collab]: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests
167-
168-
16934
## Useful links and resources
17035

17136
The following links may be useful:

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